Monitoring status (IRPCMonitoringStatus)
Reads the vault's monitoring indicators; currently the status of the search indexes.
This interface provides access to vault specific monitoring indicators.
| gRPC service | MFiles.IRPCMonitoringStatus |
|---|---|
| Book and level | Administration API, specialized |
| Methods | 3 |
| Proto file | mfiles/IRPCMonitoringStatus.proto |
Overview
M-Files Admin uses this service to show the indexing status of a vault (whether indexing or a
rebuild is running, batch times, items processed). The only supported context is
MONITORING_CONTEXT_INDEXING; other contexts fail with "Not implemented.".
Sessions and rights. Every method requires a vault session with the vault right
see_all_objects (VaultAccess); vault administrators have it.
A server-level session fails with "Login required.", a normal user with "Access denied.".
Typical order: list the index sources with GetIndicatorSources, then read their values with GetIndicators. GetActiveNotifications gives a quick summary as flags.
Methods
| Method | Summary | Facts |
|---|---|---|
| GetActiveNotifications | Gets the active indexing notifications of the vault, such as "re-indexing required" or "rebuild in progress", combined over all indexes. | admin session |
| GetIndicators | Gets the indicator values of the vault's monitoring sources, optionally for one source. | admin session |
| GetIndicatorSources | Lists the monitoring sources of the vault, for indexing one source per index and partition. | admin session |