IRPCMonitoringStatus.GetIndicators

View as Markdown

Administration API / specialized admin session

Gets the indicator values of the vault's monitoring sources, optionally for one source.

ServiceMonitoring status MFiles.IRPCMonitoringStatus
gRPC method/MFiles.IRPCMonitoringStatus/GetIndicators
HTTP (mf-http-grpc)POST /grpc/v1/get-indicators
RequestGetIndicatorsRequest
ResponseGetIndicatorsResponse
Book and levelAdministration API, specialized
Kindadmin
SessionRequired: the session ID from LogIn in the mfiles-session-id-bin metadata.
Idempotentno
Returns metadata structure versionno
Streamingnone (unary)

Remarks

Request: GetIndicatorsRequest

Nested message fields are expanded to depth 3; follow a type link for deeper levels and for the type's own page.

FieldTypeDescription
source_filterMonitoringSourceThe context and, optionally, descriptors (as returned by GetIndicatorSources) that select the sources.
source_filter.contextMonitoringContextThe context of the monitoring source.Values: MONITORING_CONTEXT_UNSPECIFIED (0), MONITORING_CONTEXT_INDEXING (1).
source_filter.descriptors[]repeated TaggedValueThe descriptors of the monitoring source as a tagged value array.
source_filter.descriptors[].tagstringThe name of the tagged value.
source_filter.descriptors[].value_typeTaggedValueTypeThe 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[].valuestringThe 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.

FieldTypeDescription
data[]repeated MonitoringIndicatorDataOne entry per source, with its indicators.
data[].sourceMonitoringSourceIndicator data source.
data[].source.contextMonitoringContextThe context of the monitoring source.Values: MONITORING_CONTEXT_UNSPECIFIED (0), MONITORING_CONTEXT_INDEXING (1).
data[].source.descriptors[]repeated TaggedValueThe descriptors of the monitoring source as a tagged value array.
data[].indicators[]repeated MonitoringIndicatorIndicator data as a monitoring indicator array.
data[].indicators[].valueTaggedValueThe indicator value.
data[].indicators[].generated_atstringThe ISO 8601 timestamp (in UTC) of the indicator value generation.