Remove documentation for upcoming /pki/tidy-status endpoint. (#14044)
The documentation will be released along with the feature.
This commit is contained in:
Victor Rodriguez
GitHub
parent
1b70677eba
commit
88e02feab0
|
|
@ -1671,55 +1671,6 @@ $ curl \
|
|||
http://127.0.0.1:8200/v1/pki/tidy
|
||||
```
|
||||
|
||||
## Tidy Status
|
||||
|
||||
This is a read only endpoint that returns information about the current tidy
|
||||
operation, or the most recent if none are currently running.
|
||||
|
||||
The result includes the following fields:
|
||||
* `safety_buffer`: the value of this parameter when initiating the tidy operation
|
||||
* `tidy_cert_store`: the value of this parameter when initiating the tidy operation
|
||||
* `tidy_revoked_certs`: the value of this parameter when initiating the tidy operation
|
||||
* `state`: one of *Inactive*, *Running*, *Finished*, *Error*
|
||||
* `error`: the error message, if the operation ran into an error
|
||||
* `time_started`: the time the operation started
|
||||
* `time_finished`: the time the operation finished
|
||||
* `message`: One of *Tidying certificate store: checking entry N of TOTAL* or
|
||||
*Tidying revoked certificates: checking certificate N of TOTAL*
|
||||
* `cert_store_deleted_count`: The number of certificate storage entries deleted
|
||||
* `revoked_cert_deleted_count`: The number of revoked certificate entries deleted
|
||||
|
||||
| Method | Path |
|
||||
| :----- | :----------------- |
|
||||
| `GET` | `/pki/tidy-status` |
|
||||
|
||||
### Sample Request
|
||||
|
||||
```shell-session
|
||||
$ curl \
|
||||
--header "X-Vault-Token: ..." \
|
||||
--request GET \
|
||||
http://127.0.0.1:8200/v1/pki/tidy-status
|
||||
|
||||
```
|
||||
|
||||
### Sample Response
|
||||
|
||||
```json
|
||||
"data": {
|
||||
"safety_buffer": 60,
|
||||
"tidy_cert_store": true,
|
||||
"tidy_revoked_certs": true,
|
||||
"error": null,
|
||||
"message": "Tidying certificate store: checking entry 234 of 488",
|
||||
"revoked_cert_deleted_count": 0,
|
||||
"cert_store_deleted_count": 2,
|
||||
"state": "Running",
|
||||
"time_started": "2021-10-20T14:52:13.510161-04:00",
|
||||
"time_finished": null
|
||||
},
|
||||
```
|
||||
|
||||
# Cluster Scalability
|
||||
|
||||
Most non-introspection operations in the PKI secrets engine require a write to
|
||||
|
|
|
|||
|
|
@ -289,40 +289,30 @@ These metrics relate to [Vault Enterprise Replication](/docs/enterprise/replicat
|
|||
|
||||
These metrics relate to the supported [secrets engines][secrets-engines].
|
||||
|
||||
| Metric | Description | Unit | Type |
|
||||
| :------------------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :----- | :------ |
|
||||
| `database.Initialize` | Time taken to initialize a database secret engine across all database secrets engines | ms | summary |
|
||||
| `database.<name>.Initialize` | Time taken to initialize a database secret engine for the named database secrets engine `<name>`, for example: `database.postgresql-prod.Initialize` | ms | summary |
|
||||
| `database.Initialize.error` | Number of database secrets engine initialization operation errors across all database secrets engines | errors | counter |
|
||||
| `database.<name>.Initialize.error` | Number of database secrets engine initialization operation errors for the named database secrets engine `<name>`, for example: `database.postgresql-prod.Initialize.error` | errors | counter |
|
||||
| `database.Close` | Time taken to close a database secret engine across all database secrets engines | ms | summary |
|
||||
| `database.<name>.Close` | Time taken to close a database secret engine for the named database secrets engine `<name>`, for example: `database.postgresql-prod.Close` | ms | summary |
|
||||
| `database.Close.error` | Number of database secrets engine close operation errors across all database secrets engines | errors | counter |
|
||||
| `database.<name>.Close.error` | Number of database secrets engine close operation errors for the named database secrets engine `<name>`, for example: `database.postgresql-prod.Close.error` | errors | counter |
|
||||
| `database.CreateUser` | Time taken to create a user across all database secrets engines | ms | summary |
|
||||
| `database.<name>.CreateUser` | Time taken to create a user for the named database secrets engine `<name>` | ms | summary |
|
||||
| `database.CreateUser.error` | Number of user creation operation errors across all database secrets engines | errors | counter |
|
||||
| `database.<name>.CreateUser.error` | Number of user creation operation errors for the named database secrets engine `<name>`, for example: `database.postgresql-prod.CreateUser.error` | errors | counter |
|
||||
| `database.RenewUser` | Time taken to renew a user across all database secrets engines | ms | summary |
|
||||
| `database.<name>.RenewUser` | Time taken to renew a user for the named database secrets engine `<name>`, for example: `database.postgresql-prod.RenewUser` | ms | summary |
|
||||
| `database.RenewUser.error` | Number of user renewal operation errors across all database secrets engines | errors | counter |
|
||||
| `database.<name>.RenewUser.error` | Number of user renewal operations for the named database secrets engine `<name>`, for example: `database.postgresql-prod.RenewUser.error` | errors | counter |
|
||||
| `database.RevokeUser` | Time taken to revoke a user across all database secrets engines | ms | summary |
|
||||
| `database.<name>.RevokeUser` | Time taken to revoke a user for the named database secrets engine `<name>`, for example: `database.postgresql-prod.RevokeUser` | ms | summary |
|
||||
| `database.RevokeUser.error` | Number of user revocation operation errors across all database secrets engines | errors | counter |
|
||||
| `database.<name>.RevokeUser.error` | Number of user revocation operations for the named database secrets engine `<name>`, for example: `database.postgresql-prod.RevokeUser.error` | errors | counter |
|
||||
| `secrets.pki.tidy.cert_store_current_entry` | The index of the current entry in the certificate store being verified by the tidy operation | entry index | gauge |
|
||||
| `secrets.pki.tidy.cert_store_deleted_count` | Number of entries deleted from the certificate store | entry | counter |
|
||||
| `secrets.pki.tidy.cert_store_total_entries` | Number of entries in the certificate store to verify during the tidy operation | entry | gauge |
|
||||
| `secrets.pki.tidy.duration` | Duration of time taken by the PKI tidy operation | ms | summary |
|
||||
| `secrets.pki.tidy.failure` | Number of times the PKI tidy operation has not completed due to errors | operations | counter |
|
||||
| `secrets.pki.tidy.revoked_cert_current_entry` | The index of the current revoked certificate entry in the certificate store being verified by the tidy operation | entry index | gauge |
|
||||
| `secrets.pki.tidy.revoked_cert_deleted_count` | Number of entries deleted from the certificate store for revoked certificates | entry | counter |
|
||||
| `secrets.pki.tidy.revoked_cert_total_entries` | Number of entries in the certificate store for revoked certificates to verify during the tidy operation | entry | gauge |
|
||||
| `secrets.pki.tidy.start_time_epoch` | Start time (as seconds since Jan 1 1970) when the PKI tidy operation is active, 0 otherwise | seconds | gauge |
|
||||
| `secrets.pki.tidy.success` | Number of times the PKI tidy operation has completed succcessfully | operations | counter |
|
||||
| `vault.secret.kv.count` (cluster, namespace, mount_point) | Number of entries in each key-value secret engine. | paths | gauge |
|
||||
| `vault.secret.lease.creation` (cluster, namespace, secret_engine, mount_point, creation_ttl) | Counts the number of leases created by secret engines. | leases | counter |
|
||||
| Metric | Description | Unit | Type |
|
||||
| :------------------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :----- | :------ |
|
||||
| `database.Initialize` | Time taken to initialize a database secret engine across all database secrets engines | ms | summary |
|
||||
| `database.<name>.Initialize` | Time taken to initialize a database secret engine for the named database secrets engine `<name>`, for example: `database.postgresql-prod.Initialize` | ms | summary |
|
||||
| `database.Initialize.error` | Number of database secrets engine initialization operation errors across all database secrets engines | errors | counter |
|
||||
| `database.<name>.Initialize.error` | Number of database secrets engine initialization operation errors for the named database secrets engine `<name>`, for example: `database.postgresql-prod.Initialize.error` | errors | counter |
|
||||
| `database.Close` | Time taken to close a database secret engine across all database secrets engines | ms | summary |
|
||||
| `database.<name>.Close` | Time taken to close a database secret engine for the named database secrets engine `<name>`, for example: `database.postgresql-prod.Close` | ms | summary |
|
||||
| `database.Close.error` | Number of database secrets engine close operation errors across all database secrets engines | errors | counter |
|
||||
| `database.<name>.Close.error` | Number of database secrets engine close operation errors for the named database secrets engine `<name>`, for example: `database.postgresql-prod.Close.error` | errors | counter |
|
||||
| `database.CreateUser` | Time taken to create a user across all database secrets engines | ms | summary |
|
||||
| `database.<name>.CreateUser` | Time taken to create a user for the named database secrets engine `<name>` | ms | summary |
|
||||
| `database.CreateUser.error` | Number of user creation operation errors across all database secrets engines | errors | counter |
|
||||
| `database.<name>.CreateUser.error` | Number of user creation operation errors for the named database secrets engine `<name>`, for example: `database.postgresql-prod.CreateUser.error` | errors | counter |
|
||||
| `database.RenewUser` | Time taken to renew a user across all database secrets engines | ms | summary |
|
||||
| `database.<name>.RenewUser` | Time taken to renew a user for the named database secrets engine `<name>`, for example: `database.postgresql-prod.RenewUser` | ms | summary |
|
||||
| `database.RenewUser.error` | Number of user renewal operation errors across all database secrets engines | errors | counter |
|
||||
| `database.<name>.RenewUser.error` | Number of user renewal operations for the named database secrets engine `<name>`, for example: `database.postgresql-prod.RenewUser.error` | errors | counter |
|
||||
| `database.RevokeUser` | Time taken to revoke a user across all database secrets engines | ms | summary |
|
||||
| `database.<name>.RevokeUser` | Time taken to revoke a user for the named database secrets engine `<name>`, for example: `database.postgresql-prod.RevokeUser` | ms | summary |
|
||||
| `database.RevokeUser.error` | Number of user revocation operation errors across all database secrets engines | errors | counter |
|
||||
| `database.<name>.RevokeUser.error` | Number of user revocation operations for the named database secrets engine `<name>`, for example: `database.postgresql-prod.RevokeUser.error` | errors | counter |
|
||||
| `vault.secret.kv.count` (cluster, namespace, mount_point) | Number of entries in each key-value secret engine. | paths | gauge |
|
||||
| `vault.secret.lease.creation` (cluster, namespace, secret_engine, mount_point, creation_ttl) | Counts the number of leases created by secret engines. | leases | counter |
|
||||
|
||||
## Storage Backend Metrics
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue