Skip to content

Commit

Permalink
Add info on objects cleaner status.
Browse files Browse the repository at this point in the history
  • Loading branch information
opudrovs committed Nov 15, 2023
1 parent 609b8ba commit 4e0fe36
Showing 1 changed file with 12 additions and 1 deletion.
13 changes: 12 additions & 1 deletion website/docs/explorer/operations.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -141,7 +141,7 @@ The following metrics are available to monitor its health.

##### Cluster Watcher

The metric `collector_cluster_watcher` provides the number of the cluster watchers it the following `status`:
The metric `collector_cluster_watcher` provides the number of the cluster watchers in the following `status`:
- Starting: a cluster watcher is starting at the back of detecting that a new cluster has been registered.
- Started: cluster watcher has been started and collecting events from the remote cluster. This is the stable state.
- Stopping: a cluster has been deregistered so its cluster watcher is no longer required. In the process of stopping it.
Expand Down Expand Up @@ -232,7 +232,18 @@ Explorer management path is composed of a single component exporting metrics:

The following metrics are available to monitor its health.

##### Objects Cleaner Status

The metric `objects_cleaner_status` provides telemetry on the object cleaner's `status` which can take on the following values:
- Starting: objects cleaner is starting after starting the API server.
- Started: objects cleaner has been started and is watching for objects which are expired, according to their `RetentionPolicy`, to remove them from the datastore or indexer.
- Stopped: objects cleaner has been stopped after stopping collection.
- Errored: objects cleaner has obtained an error trying to remove expired objects from the datastore or indexer. This state can be changed back to `started` after a successful attempt of removing expired objects.

```
objects_cleaner_status{status="started"} 1
objects_cleaner_status{status="starting"} 0
```

### Dashboard

Expand Down

0 comments on commit 4e0fe36

Please sign in to comment.