get-hbase-time-series

subtitle

Retrieve time series data for an HBase replication peer.

version

0.9.128

Description

Returns time series data for an HBase replication peer based on the provided parameters.

Synopsis

  get-hbase-time-series
--cluster-crn <value>
--policy-id <value>
--metric <value>
[--start-time <value>]
[--end-time <value>]
[--rollup <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton]

Options

--cluster-crn (string)

CRN of the destination cluster of the policy.

--policy-id (string)

ID of the policy that the time series data is requested for.

--metric (string)

Name of the HBase replication peer metric.

Possible values:

  • age_of_last_shipped_operation

  • log_edits_filtered_rate

  • log_edits_read_rate

  • log_queue_size

  • log_read_in_bytes_rate

  • shipped_batches_rate

  • shipped_ops_rate

  • shipped_size_in_kb_rate

  • age_of_last_shipped_operation_25th_percentile

  • age_of_last_shipped_operation_75th_percentile

  • age_of_last_shipped_operation_90th_percentile

  • age_of_last_shipped_operation_98th_percentile

  • age_of_last_shipped_operation_99th_percentile

  • age_of_last_shipped_operation_999th_percentile

  • age_of_last_shipped_operation_max

  • age_of_last_shipped_operation_mean

  • age_of_last_shipped_operation_median

  • age_of_last_shipped_operation_min

  • age_of_last_shipped_operation_rate

  • shipped_hfiles_rate

  • size_of_hfile_refs_queue

--start-time (datetime)

Start time of the time series data. Defaults to 5 minutes before end time.

--end-time (datetime)

End time of the time series data. Defaults to current time.

--rollup (string)

Aggregate rollup level for time series data. Defaults to RAW data.

Possible values:

  • RAW

  • TEN_MINUTELY

  • HOURLY

  • SIX_HOURLY

  • DAILY

  • WEEKLY

--cli-input-json (string)

Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values.

--generate-cli-skeleton (boolean)

Prints a sample input JSON to standard output. Note the specified operation is not run if this argument is specified. The sample input can be used as an argument for --cli-input-json.

Output

hbasePeerName -> (string)

Name of the HBase peer used for replication.

sourceCluster -> (string)

Name of source cluster in the format: “dataCenterName$cluster name”, for example “DC-Europe$My Source 42”.

targetCluster -> (string)

Name of destination cluster in the format: “dataCenterName$cluster name”, for example “DC-US$My Destination 17”.

timeSeries -> (object)

HBase time series data and metadata.

metadata -> (object)

Time series metadata.

metricName -> (string)

Name of the metric.

startTime -> (datetime)

Start time of the time series data.

endTime -> (datetime)

End time of the time series data.

attributes -> (object)

Attributes of the resource providing time series data.

serviceName -> (string)

Service name.

clusterName -> (string)

Cluster name.

unitNumerator -> (string)

Unit numerator.

unitDenominator -> (string)

Unit denominator.

data -> (array)

List of time series data points.

item -> (object)

Time series data point.

timestamp -> (datetime)

Timestamp of the data point.

value -> (double)

Value of the data point.

Form Factors

public