-
Notifications
You must be signed in to change notification settings - Fork 112
Security: Add new endpoint and DLS properties #5374
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
Following you can find the validation changes against the target branch for the API.
You can validate this API yourself by using the |
let me fix validate failure ^ in next PR to keep PRs scoped to one purpose, i have it passing locally
|
Thank you for this!
I'm glad that you got |
nope change is quite small i can put it into this PR if you prefer, i was thinking cleaner to have two PRs change: diff --git a/specification/xpack/usage/types.ts b/specification/xpack/usage/types.ts
index 085fff1ed..e5ad6ac55 100644
--- a/specification/xpack/usage/types.ts
+++ b/specification/xpack/usage/types.ts
@@ -320,9 +320,42 @@ export class SecurityRolesDls {
}
export class SecurityRolesDlsBitSetCache {
+ /** Number of entries in the cache. */
count: integer
+ /** Human-readable amount of memory taken up by the cache. */
memory?: ByteSize
+ /** Memory taken up by the cache in bytes. */
memory_in_bytes: ulong
+ /**
+ * Total number of cache hits.
+ * @availability stack since=9.2.0
+ * @availability serverless
+ */
+ hits: ulong
+ /**
+ * Total number of cache misses.
+ * @availability stack since=9.2.0
+ * @availability serverless
+ */
+ misses: ulong
+ /**
+ * Total number of cache evictions.
+ * @availability stack since=9.2.0
+ * @availability serverless
+ */
+ evictions: ulong
+ /**
+ * Total combined time spent in cache for hits in milliseconds.
+ * @availability stack since=9.2.0
+ * @availability serverless
+ */
+ hits_time_in_millis: ulong
+ /**
+ * Total combined time spent in cache for misses in milliseconds.
+ * @availability stack since=9.2.0
+ * @availability serverless
+ */
+ misses_time_in_millis: ulong
}
|
Including this change is fine, thank you! It's quite valuable to see the green report. Plus the SecurityRolesDlsBitSetCache changes may affect other APIs, which could affect this PR too. |
/_security/stats
specificationThere was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This looks great, thank you! A few minor adjustments are needed.
* @availability stack since=9.2.0 | ||
* @availability serverless | ||
*/ | ||
hits_time_in_millis: ulong |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
hits_time_in_millis: ulong | |
hits_time_in_millis: DurationValue<UnitMillis> |
* @availability stack since=9.2.0 | ||
* @availability serverless | ||
*/ | ||
misses_time_in_millis: ulong |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
misses_time_in_millis: ulong | |
misses_time_in_millis: DurationValue<UnitMillis> |
* @availability stack since=9.2.0 | ||
* @availability serverless | ||
*/ | ||
hits: ulong |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I realize the above uses ulong
, but let's still stick to long
for the new values since this is the actual Java type.
hits: ulong | |
hits: long |
@@ -0,0 +1,34 @@ | |||
/* |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Since those types may be exposed by another security API in the future, can you please move this file to specification/security/_types/NodeSecurityStats.ts
?
Uh oh!
There was an error while loading. Please reload this page.