hbase-protocol-shaded/src/main/protobuf/RegionServerStatus.proto

   1 /**
   2  * Licensed to the Apache Software Foundation (ASF) under one
   3  * or more contributor license agreements.  See the NOTICE file
   4  * distributed with this work for additional information
   5  * regarding copyright ownership.  The ASF licenses this file
   6  * to you under the Apache License, Version 2.0 (the
   7  * "License"); you may not use this file except in compliance
   8  * with the License.  You may obtain a copy of the License at
   9  *
  10  *     http://www.apache.org/licenses/LICENSE-2.0
  11  *
  12  * Unless required by applicable law or agreed to in writing, software
  13  * distributed under the License is distributed on an "AS IS" BASIS,
  14  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15  * See the License for the specific language governing permissions and
  16  * limitations under the License.
  17  */
  18 syntax = "proto2";
  19
  20 // This file contains protocol buffers that are used for RegionServerStatusProtocol.
  21 package hbase.pb;
  22
  23 option java_package = "org.apache.hadoop.hbase.shaded.protobuf.generated";
  24 option java_outer_classname = "RegionServerStatusProtos";
  25 option java_generic_services = true;
  26 option java_generate_equals_and_hash = true;
  27 option optimize_for = SPEED;
  28
  29 import "HBase.proto";
  30 import "ClusterStatus.proto";
  31 import "ErrorHandling.proto";
  32
  33 message RegionServerStartupRequest {
  34   /** Port number this regionserver is up on */
  35   required uint32 port = 1;
  36
  37   /** This servers' startcode */
  38   required uint64 server_start_code = 2;
  39
  40   /** Current time of the region server in ms */
  41   required uint64 server_current_time = 3;
  42
  43   /** hostname for region server, optional */
  44   optional string use_this_hostname_instead = 4;
  45 }
  46
  47 message RegionServerStartupResponse {
  48   /**
  49    * Configuration for the regionserver to use: e.g. filesystem,
  50    * hbase rootdir, the hostname to use creating the RegionServer ServerName,
  51    * etc
  52    */
  53   repeated NameStringPair map_entries = 1;
  54 }
  55
  56 message RegionServerReportRequest {
  57   required ServerName server = 1;
  58
  59   /** load the server is under */
  60   optional ServerLoad load = 2;
  61 }
  62
  63 message RegionServerReportResponse {
  64 }
  65
  66 message ReportRSFatalErrorRequest {
  67   /** name of the server experiencing the error */
  68   required ServerName server = 1;
  69
  70   /** informative text to expose in the master logs and UI */
  71   required string error_message = 2;
  72 }
  73
  74 message ReportRSFatalErrorResponse {
  75 }
  76
  77 message GetLastFlushedSequenceIdRequest {
  78   /** region name */
  79   required bytes region_name = 1;
  80 }
  81
  82 message GetLastFlushedSequenceIdResponse {
  83   /** the last WAL sequence id flushed from MemStore to HFile for the region */
  84   required uint64 last_flushed_sequence_id = 1;
  85
  86   /** the last WAL sequence id flushed from MemStore to HFile for stores of the region */
  87   repeated StoreSequenceId store_last_flushed_sequence_id = 2;
  88 }
  89
  90 message RegionStateTransition {
  91   required TransitionCode transition_code = 1;
  92
  93   /** Mutliple regions are involved during merging/splitting */
  94   repeated RegionInfo region_info = 2;
  95
  96   /** For newly opened region, the open seq num is needed */
  97   optional uint64 open_seq_num = 3;
  98
  99   repeated int64 proc_id = 4;
 100   enum TransitionCode {
 101     OPENED = 0;
 102     FAILED_OPEN = 1;
 103     /** No failed_close, in which case region server will abort */
 104     CLOSED = 2;
 105
 106     /** Ask master for ok to split/merge region(s) */
 107     READY_TO_SPLIT = 3;
 108     READY_TO_MERGE = 4;
 109
 110
 111     /** We used to have PONR enums for split and merge in here occupying
 112      positions 5 and 6 but they have since been removed. Do not reuse these
 113      indices */
 114     SPLIT = 7;
 115     MERGED = 8;
 116
 117     SPLIT_REVERTED = 9;
 118     MERGE_REVERTED = 10;
 119   }
 120 }
 121
 122 message ReportRegionStateTransitionRequest {
 123   /** This region server's server name */
 124   required ServerName server = 1;
 125
 126   repeated RegionStateTransition transition = 2;
 127 }
 128
 129 message ReportRegionStateTransitionResponse {
 130   /** Error message if failed to update the region state */
 131   optional string error_message = 1;
 132 }
 133
 134
 135 message RegionSpaceUse {
 136   optional RegionInfo region_info = 1; // A region identifier
 137   optional uint64 region_size = 2; // The size in bytes of the region
 138 }
 139
 140 /**
 141  * Reports filesystem usage for regions.
 142  */
 143 message RegionSpaceUseReportRequest {
 144   repeated RegionSpaceUse space_use = 1;
 145 }
 146
 147 message RegionSpaceUseReportResponse {
 148 }
 149
 150 message RemoteProcedureResult {
 151   required uint64 proc_id = 1;
 152   enum Status {
 153     SUCCESS = 1;
 154     ERROR = 2;
 155   }
 156   required Status status = 2;
 157   optional ForeignExceptionMessage error = 3;
 158 }
 159 message ReportProcedureDoneRequest {
 160   repeated RemoteProcedureResult result = 1;
 161 }
 162
 163 message ReportProcedureDoneResponse {
 164 }
 165
 166 message FileArchiveNotificationRequest {
 167   message FileWithSize {
 168     optional TableName table_name = 1;
 169     optional string name = 2;
 170     optional uint64 size = 3;
 171   }
 172   repeated FileWithSize archived_files = 1;
 173 }
 174
 175 message FileArchiveNotificationResponse {
 176 }
 177
 178 service RegionServerStatusService {
 179   /** Called when a region server first starts. */
 180   rpc RegionServerStartup(RegionServerStartupRequest)
 181     returns(RegionServerStartupResponse);
 182
 183   /** Called to report the load the RegionServer is under. */
 184   rpc RegionServerReport(RegionServerReportRequest)
 185     returns(RegionServerReportResponse);
 186
 187   /**
 188    * Called by a region server to report a fatal error that is causing it to
 189    * abort.
 190    */
 191   rpc ReportRSFatalError(ReportRSFatalErrorRequest)
 192     returns(ReportRSFatalErrorResponse);
 193
 194   /** Called to get the sequence id of the last MemStore entry flushed to an
 195    * HFile for a specified region. Used by the region server to speed up
 196    * log splitting. */
 197   rpc GetLastFlushedSequenceId(GetLastFlushedSequenceIdRequest)
 198     returns(GetLastFlushedSequenceIdResponse);
 199
 200   /**
 201    * Called by a region server to report the progress of a region
 202    * transition. If the request fails, the transition should
 203    * be aborted.
 204    */
 205   rpc ReportRegionStateTransition(ReportRegionStateTransitionRequest)
 206     returns(ReportRegionStateTransitionResponse);
 207
 208   /**
 209    * Reports Region filesystem space use
 210    */
 211   rpc ReportRegionSpaceUse(RegionSpaceUseReportRequest)
 212     returns(RegionSpaceUseReportResponse);
 213
 214   rpc ReportProcedureDone(ReportProcedureDoneRequest)
 215     returns(ReportProcedureDoneResponse);
 216
 217   /** Reports files that were moved to the archive directory for space quotas */
 218   rpc ReportFileArchival(FileArchiveNotificationRequest)
 219     returns(FileArchiveNotificationResponse);
 220 }