upstream/vault
1
0
Fork 0
mirror of https://github.com/hashicorp/vault.git synced 2026-02-03 20:40:45 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions 11

Remove distinct_entities and non_entity_tokens from ResponseCounts and update docs (#27849)

Browse source 
* Updated response counts

* Updated docs and removed references to derpecated fields in ResponseCounts
This commit is contained in:
divyaac 2024-07-25 10:29:23 -07:00 committed by GitHub
parent c1fcf6ad8e
commit 4bde6b5e55
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 0 additions and 120 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
vault/activity_log.go
View file

@ -1702,9 +1702,7 @@ func (a *ActivityLog) receivedFragment(fragment *activity.LogFragment) {
}
type ResponseCounts struct {
DistinctEntities int `json:"distinct_entities" mapstructure:"distinct_entities"`
EntityClients int `json:"entity_clients" mapstructure:"entity_clients"`
NonEntityTokens int `json:"non_entity_tokens" mapstructure:"non_entity_tokens"`
NonEntityClients int `json:"non_entity_clients" mapstructure:"non_entity_clients"`
Clients int `json:"clients"`
SecretSyncs int `json:"secret_syncs" mapstructure:"secret_syncs"`
@ -2878,9 +2876,7 @@ func (a *ActivityLog) partialMonthClientCount(ctx context.Context) (map[string]i
// Now populate the response based on breakdowns.
responseData := make(map[string]interface{})
responseData["by_namespace"] = byNamespaceResponse
responseData["distinct_entities"] = totalCounts.EntityClients
responseData["entity_clients"] = totalCounts.EntityClients
responseData["non_entity_tokens"] = totalCounts.NonEntityClients
responseData["non_entity_clients"] = totalCounts.NonEntityClients
responseData["clients"] = totalCounts.Clients
responseData["secret_syncs"] = totalCounts.SecretSyncs

116
website/content/api-docs/system/internal-counters.mdx
View file

@ -239,14 +239,6 @@ Vault lead to the new clients for each month.
}
```
- The `distinct_entities` field name has been deprecated since Vault 1.10. Refer to
`entity_clients` field instead. The `distinct_entities` field is currently
returned by the API for backward compatibility and it may be removed in the future.
- The `non_entity_tokens` field name has been deprecated since Vault 1.10. Refer to
`non_entity_clients` field instead. The `non_entity_tokens` field is currently
returned by the API for backward compatibility, and it may be removed in the future.
- If the `end_date` supplied to the API is for the current month, the activity
information returned by this API will only be till the previous month. The
activity system is designed to process the accumulated activity only at the end
@ -269,9 +261,7 @@ That is to say, the response will appear as follows.
{
"timestamp":"current_month_timestamp",
"counts":{
"distinct_entities":"exact int value",
"entity_clients":"exact int value",
"non_entity_tokens":"exact int value",
"non_entity_clients":"exact int value",
"secret_syncs":"exact int value",
"acme_clients":"exact int value",
@ -282,9 +272,7 @@ That is to say, the response will appear as follows.
"namespace_id":"root",
"namespace_path":"path",
"counts":{
"distinct_entities":"exact int value",
"entity_clients":"exact int value",
"non_entity_tokens":"exact int value",
"non_entity_clients":"exact int value",
"secret_syncs":"exact int value",
"acme_clients":"exact int value",
@ -294,9 +282,7 @@ That is to say, the response will appear as follows.
{
"path":"auth/up2/",
"counts":{
"distinct_entities":"exact int value",
"entity_clients":"exact int value",
"non_entity_tokens":"exact int value",
"non_entity_clients":"exact int value",
"secret_syncs":"exact int value",
"acme_clients":"exact int value",
@ -308,9 +294,7 @@ That is to say, the response will appear as follows.
],
"new_clients":{
"counts":{
"distinct_entities":"approx int value",
"entity_clients":"approx int value",
"non_entity_tokens":"approx int value",
"non_entity_clients":"approx int value",
"secret_syncs":"approx int value",
"acme_clients":"approx int value",
@ -381,9 +365,7 @@ $ curl \
"namespace_id":"root",
"namespace_path":"",
"counts":{
"distinct_entities":20,
"entity_clients":20,
"non_entity_tokens":10,
"non_entity_clients":10,
"secret_syncs": 5,
"acme_clients": 3,
@ -393,9 +375,7 @@ $ curl \
{
"path":"auth/up1/",
"counts":{
"distinct_entities":10,
"entity_clients":10,
"non_entity_tokens":10,
"non_entity_clients":10,
"secret_syncs": 0,
"acme_clients": 0,
@ -405,9 +385,7 @@ $ curl \
{
"path":"auth/up2/",
"counts":{
"distinct_entities":5,
"entity_clients":5,
"non_entity_tokens":5,
"non_entity_clients":5,
"secret_syncs": 0,
"acme_clients": 0,
@ -417,9 +395,7 @@ $ curl \
{
"path":"secrets/kv1/",
"counts":{
"distinct_entities":0,
"entity_clients":0,
"non_entity_tokens":0,
"non_entity_clients":0,
"secret_syncs":3,
"acme_clients": 0,
@ -429,9 +405,7 @@ $ curl \
{
"path":"secrets/kv2/",
"counts":{
"distinct_entities":0,
"entity_clients":0,
"non_entity_tokens":0,
"non_entity_clients":0,
"secret_syncs":0,
"acme_clients": 0,
@ -441,9 +415,7 @@ $ curl \
{
"path":"secrets/pki/",
"counts":{
"distinct_entities":0,
"entity_clients":0,
"non_entity_tokens":0,
"non_entity_clients":0,
"secret_syncs":0,
"acme_clients": 3,
@ -456,9 +428,7 @@ $ curl \
"namespace_id":"s07UR",
"namespace_path":"ns1/",
"counts":{
"distinct_entities":5,
"entity_clients":5,
"non_entity_tokens":5,
"non_entity_clients":5,
"secret_syncs":0,
"acme_clients":0,
@ -468,9 +438,7 @@ $ curl \
{
"path":"auth/up1/",
"counts":{
"distinct_entities":0,
"entity_clients":0,
"non_entity_tokens":5,
"non_entity_clients":5,
"secret_syncs":0,
"acme_clients":0,
@ -480,9 +448,7 @@ $ curl \
{
"path":"auth/up2/",
"counts":{
"distinct_entities":5,
"entity_clients":5,
"non_entity_tokens":0,
"non_entity_clients":0,
"secret_syncs":0,
"acme_clients":0,
@ -497,9 +463,7 @@ $ curl \
{
"timestamp":"2021-05-01T00:00:00Z",
"counts":{
"distinct_entities":20,
"entity_clients":20,
"non_entity_tokens":10,
"non_entity_clients":10,
"secret_syncs":5,
"acme_clients":3,
@ -510,9 +474,7 @@ $ curl \
"namespace_id":"root",
"namespace_path":"",
"counts":{
"distinct_entities":15,
"entity_clients":15,
"non_entity_tokens":5,
"non_entity_clients":5,
"secret_syncs":5,
"acme_clients":3,
@ -522,9 +484,7 @@ $ curl \
{
"path":"auth/up2/",
"counts":{
"distinct_entities":10,
"entity_clients":10,
"non_entity_tokens":5,
"non_entity_clients":5,
"secret_syncs":0,
"acme_clients":0,
@ -534,9 +494,7 @@ $ curl \
{
"path":"auth/up1/",
"counts":{
"distinct_entities":3,
"entity_clients":3,
"non_entity_tokens":2,
"non_entity_clients":2,
"secret_syncs":0,
"acme_clients":0,
@ -546,9 +504,7 @@ $ curl \
{
"path":"secrets/kv1/",
"counts":{
"distinct_entities":0,
"entity_clients":0,
"non_entity_tokens":0,
"non_entity_clients":0,
"secret_syncs":3,
"acme_clients":0,
@ -558,9 +514,7 @@ $ curl \
{
"path":"secrets/kv2/",
"counts":{
"distinct_entities":0,
"entity_clients":0,
"non_entity_tokens":0,
"non_entity_clients":0,
"secret_syncs":2,
"acme_clients":0,
@ -570,9 +524,7 @@ $ curl \
{
"path":"secrets/pki/",
"counts":{
"distinct_entities":0,
"entity_clients":0,
"non_entity_tokens":0,
"non_entity_clients":0,
"secret_syncs":0,
"acme_clients":3,
@ -585,9 +537,7 @@ $ curl \
"namespace_id":"s07UR",
"namespace_path":"ns1/",
"counts":{
"distinct_entities":5,
"entity_clients":5,
"non_entity_tokens":5,
"non_entity_clients":5,
"secret_syncs":0,
"acme_clients":0,
@ -597,9 +547,7 @@ $ curl \
{
"path":"auth/up1/",
"counts":{
"distinct_entities":0,
"entity_clients":0,
"non_entity_tokens":5,
"non_entity_clients":5,
"secret_syncs":0,
"acme_clients":0,
@ -609,9 +557,7 @@ $ curl \
{
"path":"auth/up2/",
"counts":{
"distinct_entities":5,
"entity_clients":5,
"non_entity_tokens":0,
"non_entity_clients":0,
"secret_syncs":0,
"acme_clients":0,
@ -623,9 +569,7 @@ $ curl \
],
"new_clients":{
"counts":{
"distinct_entities":10,
"entity_clients":10,
"non_entity_tokens":10,
"non_entity_clients":10,
"secret_syncs":2,
"acme_clients":1,
@ -636,9 +580,7 @@ $ curl \
"namespace_id":"root",
"namespace_path":"",
"counts":{
"distinct_entities":5,
"entity_clients":5,
"non_entity_tokens":5,
"non_entity_clients":5,
"secret_syncs":2,
"acme_clients":1,
@ -648,9 +590,7 @@ $ curl \
{
"path":"auth/up2/",
"counts":{
"distinct_entities":0,
"entity_clients":0,
"non_entity_tokens":5,
"non_entity_clients":5,
"clients":5
}
@ -658,9 +598,7 @@ $ curl \
{
"path":"auth/up1/",
"counts":{
"distinct_entities":5,
"entity_clients":5,
"non_entity_tokens":0,
"non_entity_clients":0,
"clients":5
}
@ -668,9 +606,7 @@ $ curl \
{
"path":"secrets/kv1/",
"counts":{
"distinct_entities":0,
"entity_clients":0,
"non_entity_tokens":0,
"non_entity_clients":0,
"secret_syncs":1,
"clients":1
@ -679,9 +615,7 @@ $ curl \
{
"path":"secrets/kv2/",
"counts":{
"distinct_entities":0,
"entity_clients":0,
"non_entity_tokens":0,
"non_entity_clients":0,
"secret_syncs":1,
"clients":1
@ -690,9 +624,7 @@ $ curl \
{
"path":"secrets/pki/",
"counts":{
"distinct_entities":0,
"entity_clients":0,
"non_entity_tokens":0,
"non_entity_clients":0,
"secret_syncs":0,
"acme_clients":1,
@ -705,9 +637,7 @@ $ curl \
"namespace_id":"s07UR",
"namespace_path":"ns1/",
"counts":{
"distinct_entities":5,
"entity_clients":5,
"non_entity_tokens":5,
"non_entity_clients":5,
"secret_syncs":0,
"acme_clients":0,
@ -717,9 +647,7 @@ $ curl \
{
"path":"auth/up1/",
"counts":{
"distinct_entities":0,
"entity_clients":0,
"non_entity_tokens":5,
"non_entity_clients":5,
"secret_syncs":0,
"acme_clients":0,
@ -729,9 +657,7 @@ $ curl \
{
"path":"auth/up2/",
"counts":{
"distinct_entities":5,
"entity_clients":5,
"non_entity_tokens":0,
"non_entity_clients":0,
"secret_syncs":0,
"acme_clients":0,
@ -746,9 +672,7 @@ $ curl \
{
"timestamp":"2021-04-01T00:00:00Z",
"counts":{
"distinct_entities":5,
"entity_clients":5,
"non_entity_tokens":5,
"non_entity_clients":5,
"secret_syncs":3,
"acme_clients":1,
@ -759,9 +683,7 @@ $ curl \
"namespace_id":"root",
"namespace_path":"",
"counts":{
"distinct_entities":5,
"entity_clients":5,
"non_entity_tokens":5,
"non_entity_clients":5,
"secret_syncs":0,
"acme_clients":0,
@ -771,9 +693,7 @@ $ curl \
{
"path":"auth/up1/",
"counts":{
"distinct_entities":0,
"entity_clients":0,
"non_entity_tokens":5,
"non_entity_clients":5,
"secret_syncs":0,
"acme_clients":0,
@ -783,9 +703,7 @@ $ curl \
{
"path":"auth/up2/",
"counts":{
"distinct_entities":5,
"entity_clients":5,
"non_entity_tokens":0,
"non_entity_clients":0,
"secret_syncs":0,
"acme_clients":0,
@ -797,9 +715,7 @@ $ curl \
],
"new_clients":{
"counts":{
"distinct_entities":5,
"entity_clients":5,
"non_entity_tokens":5,
"non_entity_clients":5,
"secret_syncs":3,
"acme_clients":1,
@ -810,9 +726,7 @@ $ curl \
"namespace_id":"root",
"namespace_path":"",
"counts":{
"distinct_entities":5,
"entity_clients":5,
"non_entity_tokens":5,
"non_entity_clients":5,
"secret_syncs":3,
"acme_clients":1,
@ -822,9 +736,7 @@ $ curl \
{
"path":"auth/up1/",
"counts":{
"distinct_entities":0,
"entity_clients":0,
"non_entity_tokens":5,
"non_entity_clients":5,
"secret_syncs":0,
"acme_clients":0,
@ -834,9 +746,7 @@ $ curl \
{
"path":"auth/up2/",
"counts":{
"distinct_entities":5,
"entity_clients":5,
"non_entity_tokens":0,
"non_entity_clients":0,
"secret_syncs":0,
"acme_clients":0,
@ -846,9 +756,7 @@ $ curl \
{
"path":"secrets/kv1/",
"counts":{
"distinct_entities":0,
"entity_clients":0,
"non_entity_tokens":0,
"non_entity_clients":0,
"secret_syncs":2,
"acme_clients":0,
@ -858,9 +766,7 @@ $ curl \
{
"path":"secrets/kv2/",
"counts":{
"distinct_entities":0,
"entity_clients":0,
"non_entity_tokens":0,
"non_entity_clients":0,
"secret_syncs":1,
"acme_clients":0,
@ -870,9 +776,7 @@ $ curl \
{
"path":"secrets/pki/",
"counts":{
"distinct_entities":0,
"entity_clients":0,
"non_entity_tokens":0,
"non_entity_clients":0,
"secret_syncs":0,
"acme_clients":1,
@ -887,9 +791,7 @@ $ curl \
],
"start_time":"2021-01-01T00:00:00Z",
"total":{
"distinct_entities":20,
"entity_clients":20,
"non_entity_tokens":20,
"non_entity_clients":20,
"secret_syncs":5,
"acme_clients":3,
@ -965,10 +867,8 @@ $ curl \
"counts": {
"acme_clients": 0,
"clients": 1,
"distinct_entities": 0,
"entity_clients": 0,
"non_entity_clients": 1,
"non_entity_tokens": 1,
"secret_syncs": 0
},
"mounts": [
@ -976,10 +876,8 @@ $ curl \
"counts": {
"acme_clients": 0,
"clients": 1,
"distinct_entities": 0,
"entity_clients": 0,
"non_entity_clients": 1,
"non_entity_tokens": 0,
"secret_syncs": 0
},
"mount_path": "auth_token_0747d59c"
@ -990,17 +888,14 @@ $ curl \
}
],
"clients": 1,
"distinct_entities": 0,
"entity_clients": 0,
"months": [
{
"counts": {
"acme_clients": 0,
"clients": 1,
"distinct_entities": 0,
"entity_clients": 0,
"non_entity_clients": 1,
"non_entity_tokens": 0,
"secret_syncs": 0
},
"namespaces": [
@ -1008,10 +903,8 @@ $ curl \
"counts": {
"acme_clients": 0,
"clients": 1,
"distinct_entities": 0,
"entity_clients": 0,
"non_entity_clients": 1,
"non_entity_tokens": 0,
"secret_syncs": 0
},
"mounts": [
@ -1019,10 +912,8 @@ $ curl \
"counts": {
"acme_clients": 0,
"clients": 1,
"distinct_entities": 0,
"entity_clients": 0,
"non_entity_clients": 1,
"non_entity_tokens": 0,
"secret_syncs": 0
},
"mount_path": "auth_token_0747d59c"
@ -1036,10 +927,8 @@ $ curl \
"counts": {
"acme_clients": 0,
"clients": 1,
"distinct_entities": 0,
"entity_clients": 0,
"non_entity_clients": 1,
"non_entity_tokens": 0,
"secret_syncs": 0
},
"namespaces": [
@ -1047,10 +936,8 @@ $ curl \
"counts": {
"acme_clients": 0,
"clients": 1,
"distinct_entities": 0,
"entity_clients": 0,
"non_entity_clients": 1,
"non_entity_tokens": 0,
"secret_syncs": 0
},
"mounts": [
@ -1058,10 +945,8 @@ $ curl \
"counts": {
"acme_clients": 0,
"clients": 1,
"distinct_entities": 0,
"entity_clients": 0,
"non_entity_clients": 1,
"non_entity_tokens": 0,
"secret_syncs": 0
},
"mount_path": "auth_token_0747d59c"
@ -1076,7 +961,6 @@ $ curl \
}
],
"non_entity_clients": 1,
"non_entity_tokens": 1,
"secret_syncs": 0
},
"warnings": null