Monitoring data points (IRPCMonitoringDatapointsSink)
Receives the progress and status data points that the M-Files indexing service reports about each index of the vault.
This interface provides access for providing datapoints for the monitoring purposes.
| gRPC service | MFiles.IRPCMonitoringDatapointsSink |
|---|---|
| Book and level | Server integration API, specialized |
| Methods | 4 |
| Proto file | mfiles/IRPCMonitoringDatapointsSink.proto |
Overview
For M-Files components only. The M-Files indexing service (the indexer process that M-Files Server runs for the vault's search indexes) pushes data points here while it indexes. Applications should not call it.
- Caller and authentication: the indexer logs in to the vault with Windows authentication as an internal process of M-Files Server, under the server's own service account, and so has the system administrator server role.
- Rights: every method requires a vault session whose login has the system administrator
server role (server right
log_in_to_any_vault) and the vault rightschange_metadata_structure,see_all_objectsandlicense_allows_modifications. A vault administrator without the server role is denied. - Data: the server stores the data points in the vault per index (
source) and uses them for the indexing indicators that GetIndicators reports. Read indexing status through IRPCMonitoringStatus. - Order of calls: PushDatapointsForIndexingCommon for index-level data, then for each indexing batch PushDatapointsForIndexingBegin and PushDatapointsForIndexingEnd. ClearDatapointsForIndexing removes the stored data points of an index.
Methods
| Method | Summary | Facts |
|---|---|---|
| ClearDatapointsForIndexing | Deletes the stored indexing data points of one index. | internal: not for applications write session |
| PushDatapointsForIndexingBegin | Stores the data points of the start of an indexing batch: the indexing mode, the start position and the number of items to process. | internal: not for applications write session |
| PushDatapointsForIndexingCommon | Stores index-level data points of one index: data format capabilities, index size and the times of the last rebuild. | internal: not for applications write session |
| PushDatapointsForIndexingEnd | Stores the data points of the end of an indexing batch: timing, item counts and failures. | internal: not for applications write session |