IRPCMonitoringStatus.GetIndicators
Administration API / specialized admin session
Gets the indicator values of the vault's monitoring sources, optionally for one source.
| Service | Monitoring status MFiles.IRPCMonitoringStatus |
|---|---|
| gRPC method | /MFiles.IRPCMonitoringStatus/GetIndicators |
| HTTP (mf-http-grpc) | POST /grpc/v1/get-indicators |
| Request | GetIndicatorsRequest |
| Response | GetIndicatorsResponse |
| Book and level | Administration API, specialized |
| Kind | admin |
| Session | Required: the session ID from LogIn in the mfiles-session-id-bin metadata. |
| Idempotent | no |
| Returns metadata structure version | no |
| Streaming | none (unary) |
Remarks
- Requires a vault session with the vault right
see_all_objects. source_filter.contextmust beMONITORING_CONTEXT_INDEXING. Descriptors you leave out match any value, so a filter with only the context returns all indexes.- Each indicator is a tagged value with the time it was generated, for example
Common.rebuildInProgressorNormal.batchCommittedAt.
Request: GetIndicatorsRequest
Nested message fields are expanded to depth 3; follow a type link for deeper levels and for the type's own page.
| Field | Type | Description |
|---|---|---|
source_filter | MonitoringSource | The context and, optionally, descriptors (as returned by GetIndicatorSources) that select the sources. |
source_filter.context | MonitoringContext | The context of the monitoring source.Values: MONITORING_CONTEXT_UNSPECIFIED (0), MONITORING_CONTEXT_INDEXING (1). |
source_filter.descriptors[] | repeated TaggedValue | The descriptors of the monitoring source as a tagged value array. |
source_filter.descriptors[].tag | string | The name of the tagged value. |
source_filter.descriptors[].value_type | TaggedValueType | The value type of the tagged value.Values: TAGGED_VALUE_TYPE_DEFAULT (0), TAGGED_VALUE_TYPE_STRING (1), TAGGED_VALUE_TYPE_INTEGER (2), TAGGED_VALUE_TYPE_FLOAT (3), TAGGED_VALUE_TYPE_BOOLEAN (4), TAGGED_VALUE_TYPE_DATETIME (5), TAGGED_VALUE_TYPE_INT64 (6). |
source_filter.descriptors[].value | string | The string representation of the tagged value. |
Response: GetIndicatorsResponse
Nested message fields are expanded to depth 3; follow a type link for deeper levels and for the type's own page.
| Field | Type | Description |
|---|---|---|
data[] | repeated MonitoringIndicatorData | One entry per source, with its indicators. |
data[].source | MonitoringSource | Indicator data source. |
data[].source.context | MonitoringContext | The context of the monitoring source.Values: MONITORING_CONTEXT_UNSPECIFIED (0), MONITORING_CONTEXT_INDEXING (1). |
data[].source.descriptors[] | repeated TaggedValue | The descriptors of the monitoring source as a tagged value array. |
data[].indicators[] | repeated MonitoringIndicator | Indicator data as a monitoring indicator array. |
data[].indicators[].value | TaggedValue | The indicator value. |
data[].indicators[].generated_at | string | The ISO 8601 timestamp (in UTC) of the indicator value generation. |