Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Document telemetry fields for stack security features #96638

Merged
merged 2 commits into from
Apr 9, 2021
Merged

Document telemetry fields for stack security features #96638

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ecb8453
Document telemetry fields for stack security features
legrego Apr 8, 2021
42d3427
update telemetry schena
legrego Apr 8, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions x-pack/plugins/security/server/usage_collector/security_usage_collector.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,26 +53,49 @@ export function registerSecurityUsageCollector({ usageCollection, config, licens
schema: {
auditLoggingEnabled: {
type: 'boolean',
_meta: {
description:
'Indicates if audit logging is both enabled and supported by the current license.',
},
},
loginSelectorEnabled: {
type: 'boolean',
_meta: {
description: 'Indicates if the login selector UI is enabled.',
},
},
accessAgreementEnabled: {
type: 'boolean',
_meta: {
description:
'Indicates if the access agreement UI is both enabled and supported by the current license.',
},
},
authProviderCount: {
type: 'long',
_meta: {
description:
'The number of configured auth providers (including disabled auth providers).',
},
},
enabledAuthProviders: {
type: 'array',
items: {
type: 'keyword',
_meta: {
description:
'The types of enabled auth providers (such as `saml`, `basic`, `pki`, etc).',
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is unique auth providers, right? In that case perhaps this would be a better description:

Suggested change
'The types of enabled auth providers (such as `saml`, `basic`, `pki`, etc).',
'The unique types of enabled auth providers (such as `saml`, `basic`, `pki`, etc).',

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yours is technically more accurate, but I'm not sure it does much to improve the overall understanding of the field. I'm ultimately indifferent, so if you think it makes it clearer I'll go ahead and make the change

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

technically more accurate

image

In all seriousness I think it's fine as-is!

},
},
},
httpAuthSchemes: {
type: 'array',
items: {
type: 'keyword',
_meta: {
description:
'The set of enabled http auth schemes. Used for api-based usage, and when credentials are provided via reverse-proxy.',
},
},
},
},
Expand Down
30 changes: 24 additions & 6 deletions x-pack/plugins/telemetry_collection_xpack/schema/xpack_plugins.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3896,27 +3896,45 @@
"security": {
"properties": {
"auditLoggingEnabled": {
"type": "boolean"
"type": "boolean",
"_meta": {
"description": "Indicates if audit logging is both enabled and supported by the current license."
}
},
"loginSelectorEnabled": {
"type": "boolean"
"type": "boolean",
"_meta": {
"description": "Indicates if the login selector UI is enabled."
}
},
"accessAgreementEnabled": {
"type": "boolean"
"type": "boolean",
"_meta": {
"description": "Indicates if the access agreement UI is both enabled and supported by the current license."
}
},
"authProviderCount": {
"type": "long"
"type": "long",
"_meta": {
"description": "The number of configured auth providers (including disabled auth providers)."
}
},
"enabledAuthProviders": {
"type": "array",
"items": {
"type": "keyword"
"type": "keyword",
"_meta": {
"description": "The types of enabled auth providers (such as `saml`, `basic`, `pki`, etc)."
}
}
},
"httpAuthSchemes": {
"type": "array",
"items": {
"type": "keyword"
"type": "keyword",
"_meta": {
"description": "The set of enabled http auth schemes. Used for api-based usage, and when credentials are provided via reverse-proxy."
}
}
}
}
Expand Down