mirror of
https://github.com/elastic/kibana.git
synced 2025-06-27 18:51:07 -04:00
12695646cf
- Added new Profiling settings so users can customize the CO2 variables
- Fixed Embeddable components to also read the new settings
- Moved code from APM to obs-shared to create the custom settings page
in Profiling.
- New Settings Page was created in Profiling UI so users can easily find
the settings:
<img width="2053" alt="Screenshot 2023-09-22 at 11 18 35"
src="6969b079-745d-4302-8ff2-4f0f256c7f51">
---------
Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>
458 lines
18 KiB
TypeScript
458 lines
18 KiB
TypeScript
/*
|
|
* Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
|
|
* or more contributor license agreements. Licensed under the Elastic License
|
|
* 2.0; you may not use this file except in compliance with the Elastic License
|
|
* 2.0.
|
|
*/
|
|
|
|
import { schema } from '@kbn/config-schema';
|
|
import { UiSettingsParams } from '@kbn/core/types';
|
|
import { i18n } from '@kbn/i18n';
|
|
import { observabilityFeatureId, ProgressiveLoadingQuality } from '../common';
|
|
import {
|
|
enableComparisonByDefault,
|
|
enableInspectEsQueries,
|
|
maxSuggestions,
|
|
defaultApmServiceEnvironment,
|
|
apmProgressiveLoading,
|
|
apmServiceInventoryOptimizedSorting,
|
|
apmServiceGroupMaxNumberOfServices,
|
|
apmTraceExplorerTab,
|
|
apmLabsButton,
|
|
enableAgentExplorerView,
|
|
enableAwsLambdaMetrics,
|
|
apmAWSLambdaPriceFactor,
|
|
apmAWSLambdaRequestCostPerMillion,
|
|
apmEnableServiceMetrics,
|
|
apmEnableContinuousRollups,
|
|
enableCriticalPath,
|
|
enableInfrastructureHostsView,
|
|
syntheticsThrottlingEnabled,
|
|
enableLegacyUptimeApp,
|
|
apmEnableProfilingIntegration,
|
|
profilingCo2PerKWH,
|
|
profilingDatacenterPUE,
|
|
profilingPerCoreWatt,
|
|
} from '../common/ui_settings_keys';
|
|
|
|
const betaLabel = i18n.translate('xpack.observability.uiSettings.betaLabel', {
|
|
defaultMessage: 'beta',
|
|
});
|
|
|
|
const technicalPreviewLabel = i18n.translate(
|
|
'xpack.observability.uiSettings.technicalPreviewLabel',
|
|
{ defaultMessage: 'technical preview' }
|
|
);
|
|
|
|
type UiSettings = UiSettingsParams<boolean | number | string | object> & { showInLabs?: boolean };
|
|
|
|
/**
|
|
* uiSettings definitions for Observability.
|
|
*/
|
|
export const uiSettings: Record<string, UiSettings> = {
|
|
[enableInspectEsQueries]: {
|
|
category: [observabilityFeatureId],
|
|
name: i18n.translate('xpack.observability.enableInspectEsQueriesExperimentName', {
|
|
defaultMessage: 'Inspect ES queries',
|
|
}),
|
|
value: false,
|
|
description: i18n.translate('xpack.observability.enableInspectEsQueriesExperimentDescription', {
|
|
defaultMessage: 'Inspect Elasticsearch queries in API responses.',
|
|
}),
|
|
schema: schema.boolean(),
|
|
requiresPageReload: true,
|
|
},
|
|
[maxSuggestions]: {
|
|
category: [observabilityFeatureId],
|
|
name: i18n.translate('xpack.observability.maxSuggestionsUiSettingName', {
|
|
defaultMessage: 'Maximum suggestions',
|
|
}),
|
|
value: 100,
|
|
description: i18n.translate('xpack.observability.maxSuggestionsUiSettingDescription', {
|
|
defaultMessage: 'Maximum number of suggestions fetched in autocomplete selection boxes.',
|
|
}),
|
|
schema: schema.number(),
|
|
},
|
|
[enableComparisonByDefault]: {
|
|
category: [observabilityFeatureId],
|
|
name: i18n.translate('xpack.observability.enableComparisonByDefault', {
|
|
defaultMessage: 'Comparison feature',
|
|
}),
|
|
value: true,
|
|
description: i18n.translate('xpack.observability.enableComparisonByDefaultDescription', {
|
|
defaultMessage:
|
|
'Determines whether the comparison feature is enabled or disabled by default in the APM app.',
|
|
}),
|
|
schema: schema.boolean(),
|
|
},
|
|
[defaultApmServiceEnvironment]: {
|
|
category: [observabilityFeatureId],
|
|
sensitive: true,
|
|
name: i18n.translate('xpack.observability.defaultApmServiceEnvironment', {
|
|
defaultMessage: 'Default service environment',
|
|
}),
|
|
description: i18n.translate('xpack.observability.defaultApmServiceEnvironmentDescription', {
|
|
defaultMessage:
|
|
'Set the default environment for the APM app. When left empty, data from all environments will be displayed by default.',
|
|
}),
|
|
value: '',
|
|
schema: schema.string(),
|
|
},
|
|
[apmProgressiveLoading]: {
|
|
category: [observabilityFeatureId],
|
|
name: i18n.translate('xpack.observability.apmProgressiveLoading', {
|
|
defaultMessage: 'Use progressive loading of selected APM views',
|
|
}),
|
|
description: i18n.translate('xpack.observability.apmProgressiveLoadingDescription', {
|
|
defaultMessage:
|
|
'{technicalPreviewLabel} Whether to load data progressively for APM views. Data may be requested with a lower sampling rate first, with lower accuracy but faster response times, while the unsampled data loads in the background',
|
|
values: { technicalPreviewLabel: `<em>[${technicalPreviewLabel}]</em>` },
|
|
}),
|
|
value: ProgressiveLoadingQuality.off,
|
|
schema: schema.oneOf([
|
|
schema.literal(ProgressiveLoadingQuality.off),
|
|
schema.literal(ProgressiveLoadingQuality.low),
|
|
schema.literal(ProgressiveLoadingQuality.medium),
|
|
schema.literal(ProgressiveLoadingQuality.high),
|
|
]),
|
|
requiresPageReload: false,
|
|
type: 'select',
|
|
options: [
|
|
ProgressiveLoadingQuality.off,
|
|
ProgressiveLoadingQuality.low,
|
|
ProgressiveLoadingQuality.medium,
|
|
ProgressiveLoadingQuality.high,
|
|
],
|
|
optionLabels: {
|
|
[ProgressiveLoadingQuality.off]: i18n.translate(
|
|
'xpack.observability.apmProgressiveLoadingQualityOff',
|
|
{
|
|
defaultMessage: 'Off',
|
|
}
|
|
),
|
|
[ProgressiveLoadingQuality.low]: i18n.translate(
|
|
'xpack.observability.apmProgressiveLoadingQualityLow',
|
|
{
|
|
defaultMessage: 'Low sampling rate (fastest, least accurate)',
|
|
}
|
|
),
|
|
[ProgressiveLoadingQuality.medium]: i18n.translate(
|
|
'xpack.observability.apmProgressiveLoadingQualityMedium',
|
|
{
|
|
defaultMessage: 'Medium sampling rate',
|
|
}
|
|
),
|
|
[ProgressiveLoadingQuality.high]: i18n.translate(
|
|
'xpack.observability.apmProgressiveLoadingQualityHigh',
|
|
{
|
|
defaultMessage: 'High sampling rate (slower, most accurate)',
|
|
}
|
|
),
|
|
},
|
|
showInLabs: true,
|
|
},
|
|
[apmServiceInventoryOptimizedSorting]: {
|
|
category: [observabilityFeatureId],
|
|
name: i18n.translate('xpack.observability.apmServiceInventoryOptimizedSorting', {
|
|
defaultMessage: 'Optimize services list load performance in APM',
|
|
}),
|
|
description: i18n.translate(
|
|
'xpack.observability.apmServiceInventoryOptimizedSortingDescription',
|
|
{
|
|
defaultMessage:
|
|
'{technicalPreviewLabel} Default APM Service Inventory and Storage Explorer pages sort (for Services without Machine Learning applied) to sort by Service Name.',
|
|
values: {
|
|
technicalPreviewLabel: `<em>[${technicalPreviewLabel}]</em>`,
|
|
},
|
|
}
|
|
),
|
|
schema: schema.boolean(),
|
|
value: false,
|
|
requiresPageReload: false,
|
|
type: 'boolean',
|
|
showInLabs: true,
|
|
},
|
|
[apmServiceGroupMaxNumberOfServices]: {
|
|
category: [observabilityFeatureId],
|
|
name: i18n.translate('xpack.observability.serviceGroupMaxServicesUiSettingName', {
|
|
defaultMessage: 'Maximum services in a service group',
|
|
}),
|
|
value: 500,
|
|
description: i18n.translate('xpack.observability.serviceGroupMaxServicesUiSettingDescription', {
|
|
defaultMessage: 'Limit the number of services in a given service group',
|
|
}),
|
|
schema: schema.number({ min: 1 }),
|
|
},
|
|
[apmTraceExplorerTab]: {
|
|
category: [observabilityFeatureId],
|
|
name: i18n.translate('xpack.observability.apmTraceExplorerTab', {
|
|
defaultMessage: 'APM Trace Explorer',
|
|
}),
|
|
description: i18n.translate('xpack.observability.apmTraceExplorerTabDescription', {
|
|
defaultMessage:
|
|
'{technicalPreviewLabel} Enable the APM Trace Explorer feature, that allows you to search and inspect traces with KQL or EQL. {link}',
|
|
values: {
|
|
technicalPreviewLabel: `<em>[${technicalPreviewLabel}]</em>`,
|
|
link: traceExplorerDocsLink({
|
|
href: 'https://www.elastic.co/guide/en/kibana/master/traces.html#trace-explorer',
|
|
}),
|
|
},
|
|
}),
|
|
schema: schema.boolean(),
|
|
value: true,
|
|
requiresPageReload: true,
|
|
type: 'boolean',
|
|
showInLabs: true,
|
|
},
|
|
[apmLabsButton]: {
|
|
category: [observabilityFeatureId],
|
|
name: i18n.translate('xpack.observability.apmLabs', {
|
|
defaultMessage: 'Enable labs button in APM',
|
|
}),
|
|
description: i18n.translate('xpack.observability.apmLabsDescription', {
|
|
defaultMessage:
|
|
'This flag determines if the viewer has access to the Labs button, a quick way to enable and disable technical preview features in APM.',
|
|
}),
|
|
schema: schema.boolean(),
|
|
value: false,
|
|
requiresPageReload: true,
|
|
type: 'boolean',
|
|
},
|
|
[enableInfrastructureHostsView]: {
|
|
category: [observabilityFeatureId],
|
|
name: i18n.translate('xpack.observability.enableInfrastructureHostsView', {
|
|
defaultMessage: 'Infrastructure Hosts view',
|
|
}),
|
|
value: true,
|
|
description: i18n.translate('xpack.observability.enableInfrastructureHostsViewDescription', {
|
|
defaultMessage: '{betaLabel} Enable the Hosts view in the Infrastructure app.',
|
|
values: {
|
|
betaLabel: `<em>[${betaLabel}]</em>`,
|
|
},
|
|
}),
|
|
schema: schema.boolean(),
|
|
},
|
|
[enableAwsLambdaMetrics]: {
|
|
category: [observabilityFeatureId],
|
|
name: i18n.translate('xpack.observability.enableAwsLambdaMetrics', {
|
|
defaultMessage: 'AWS Lambda Metrics',
|
|
}),
|
|
description: i18n.translate('xpack.observability.enableAwsLambdaMetricsDescription', {
|
|
defaultMessage:
|
|
'{technicalPreviewLabel} Display Amazon Lambda metrics in the service metrics tab.',
|
|
values: {
|
|
technicalPreviewLabel: `<em>[${technicalPreviewLabel}]</em>`,
|
|
},
|
|
}),
|
|
schema: schema.boolean(),
|
|
value: true,
|
|
requiresPageReload: true,
|
|
type: 'boolean',
|
|
showInLabs: true,
|
|
},
|
|
[enableAgentExplorerView]: {
|
|
category: [observabilityFeatureId],
|
|
name: i18n.translate('xpack.observability.enableAgentExplorer', {
|
|
defaultMessage: 'Agent explorer',
|
|
}),
|
|
description: i18n.translate('xpack.observability.enableAgentExplorerDescription', {
|
|
defaultMessage: '{betaLabel} Enables Agent explorer view.',
|
|
values: {
|
|
betaLabel: `<em>[${betaLabel}]</em>`,
|
|
},
|
|
}),
|
|
schema: schema.boolean(),
|
|
value: true,
|
|
requiresPageReload: true,
|
|
type: 'boolean',
|
|
},
|
|
[apmAWSLambdaPriceFactor]: {
|
|
category: [observabilityFeatureId],
|
|
name: i18n.translate('xpack.observability.apmAWSLambdaPricePerGbSeconds', {
|
|
defaultMessage: 'AWS lambda price factor',
|
|
}),
|
|
type: 'json',
|
|
value: JSON.stringify({ x86_64: 0.0000166667, arm: 0.0000133334 }, null, 2),
|
|
description: i18n.translate('xpack.observability.apmAWSLambdaPricePerGbSecondsDescription', {
|
|
defaultMessage: 'Price per Gb-second.',
|
|
}),
|
|
schema: schema.object({
|
|
arm: schema.number(),
|
|
x86_64: schema.number(),
|
|
}),
|
|
},
|
|
[apmAWSLambdaRequestCostPerMillion]: {
|
|
category: [observabilityFeatureId],
|
|
name: i18n.translate('xpack.observability.apmAWSLambdaRequestCostPerMillion', {
|
|
defaultMessage: 'AWS lambda price per 1M requests',
|
|
}),
|
|
value: 0.2,
|
|
schema: schema.number({ min: 0 }),
|
|
},
|
|
[apmEnableServiceMetrics]: {
|
|
category: [observabilityFeatureId],
|
|
name: i18n.translate('xpack.observability.apmEnableServiceMetrics', {
|
|
defaultMessage: 'Service transaction metrics',
|
|
}),
|
|
value: true,
|
|
description: i18n.translate('xpack.observability.apmEnableServiceMetricsDescription', {
|
|
defaultMessage:
|
|
'{betaLabel} Enables the usage of service transaction metrics, which are low cardinality metrics that can be used by certain views like the service inventory for faster loading times.',
|
|
values: { betaLabel: `<em>[${betaLabel}]</em>` },
|
|
}),
|
|
schema: schema.boolean(),
|
|
requiresPageReload: true,
|
|
},
|
|
[apmEnableContinuousRollups]: {
|
|
category: [observabilityFeatureId],
|
|
name: i18n.translate('xpack.observability.apmEnableContinuousRollups', {
|
|
defaultMessage: 'Continuous rollups',
|
|
}),
|
|
value: true,
|
|
description: i18n.translate('xpack.observability.apmEnableContinuousRollupsDescription', {
|
|
defaultMessage:
|
|
'{betaLabel} When continuous rollups is enabled, the UI will select metrics with the appropriate resolution. On larger time ranges, lower resolution metrics will be used, which will improve loading times.',
|
|
values: { betaLabel: `<em>[${betaLabel}]</em>` },
|
|
}),
|
|
schema: schema.boolean(),
|
|
requiresPageReload: true,
|
|
},
|
|
[enableCriticalPath]: {
|
|
category: [observabilityFeatureId],
|
|
name: i18n.translate('xpack.observability.enableCriticalPath', {
|
|
defaultMessage: 'Critical path',
|
|
}),
|
|
description: i18n.translate('xpack.observability.enableCriticalPathDescription', {
|
|
defaultMessage: '{technicalPreviewLabel} Optionally display the critical path of a trace.',
|
|
values: {
|
|
technicalPreviewLabel: `<em>[${technicalPreviewLabel}]</em>`,
|
|
},
|
|
}),
|
|
schema: schema.boolean(),
|
|
value: false,
|
|
requiresPageReload: true,
|
|
type: 'boolean',
|
|
showInLabs: true,
|
|
},
|
|
[syntheticsThrottlingEnabled]: {
|
|
category: [observabilityFeatureId],
|
|
name: i18n.translate('xpack.observability.syntheticsThrottlingEnabledExperimentName', {
|
|
defaultMessage: 'Enable Synthetics throttling (Experimental)',
|
|
}),
|
|
value: false,
|
|
description: i18n.translate(
|
|
'xpack.observability.syntheticsThrottlingEnabledExperimentDescription',
|
|
{
|
|
defaultMessage:
|
|
'Enable the throttling setting in Synthetics monitor configurations. Note that throttling may still not be available for your monitors even if the setting is active. Intended for internal use only. {link}',
|
|
values: {
|
|
link: throttlingDocsLink({
|
|
href: 'https://github.com/elastic/synthetics/blob/main/docs/throttling.md',
|
|
}),
|
|
},
|
|
}
|
|
),
|
|
schema: schema.boolean(),
|
|
requiresPageReload: true,
|
|
},
|
|
[enableLegacyUptimeApp]: {
|
|
category: [observabilityFeatureId],
|
|
name: i18n.translate('xpack.observability.enableLegacyUptimeApp', {
|
|
defaultMessage: 'Always show legacy Uptime app',
|
|
}),
|
|
value: false,
|
|
description: i18n.translate('xpack.observability.enableLegacyUptimeAppDescription', {
|
|
defaultMessage:
|
|
"By default, the legacy Uptime app is hidden from the interface when it doesn't have any data for more than a week. Enable this option to always show it.",
|
|
}),
|
|
schema: schema.boolean(),
|
|
requiresPageReload: true,
|
|
},
|
|
[apmEnableProfilingIntegration]: {
|
|
category: [observabilityFeatureId],
|
|
name: i18n.translate('xpack.observability.apmEnableProfilingIntegration', {
|
|
defaultMessage: 'Enable Universal Profiling integration in APM',
|
|
}),
|
|
value: false,
|
|
schema: schema.boolean(),
|
|
requiresPageReload: false,
|
|
},
|
|
[profilingPerCoreWatt]: {
|
|
category: [observabilityFeatureId],
|
|
name: i18n.translate('xpack.observability.profilingPerCoreWattUiSettingName', {
|
|
defaultMessage: 'Per Core Watts',
|
|
}),
|
|
value: 7,
|
|
description: i18n.translate('xpack.observability.profilingPerCoreWattUiSettingDescription', {
|
|
defaultMessage: `The average amortized per-core power consumption (based on 100% CPU utilization).`,
|
|
}),
|
|
schema: schema.number({ min: 0 }),
|
|
requiresPageReload: false,
|
|
},
|
|
[profilingDatacenterPUE]: {
|
|
category: [observabilityFeatureId],
|
|
name: i18n.translate('xpack.observability.profilingDatacenterPUEUiSettingName', {
|
|
defaultMessage: 'Data Center PUE',
|
|
}),
|
|
value: 1.7,
|
|
description: i18n.translate('xpack.observability.profilingDatacenterPUEUiSettingDescription', {
|
|
defaultMessage: `Data center power usage effectiveness (PUE) measures how efficiently a data center uses energy. Defaults to 1.7, the average on-premise data center PUE according to the {uptimeLink} survey
|
|
</br></br>
|
|
You can also use the PUE that corresponds with your cloud provider:
|
|
<ul style="list-style-type: none;margin-left: 4px;">
|
|
<li><strong>AWS:</strong> 1.135</li>
|
|
<li><strong>GCP:</strong> 1.1</li>
|
|
<li><strong>Azure:</strong> 1.185</li>
|
|
</ul>
|
|
`,
|
|
values: {
|
|
uptimeLink:
|
|
'<a href="https://ela.st/uptimeinstitute" target="_blank" rel="noopener noreferrer">' +
|
|
i18n.translate(
|
|
'xpack.observability.profilingDatacenterPUEUiSettingDescription.uptimeLink',
|
|
{ defaultMessage: 'Uptime Institute' }
|
|
) +
|
|
'</a>',
|
|
},
|
|
}),
|
|
schema: schema.number({ min: 0 }),
|
|
requiresPageReload: false,
|
|
},
|
|
[profilingCo2PerKWH]: {
|
|
category: [observabilityFeatureId],
|
|
name: i18n.translate('xpack.observability.profilingCo2PerKWHUiSettingName', {
|
|
defaultMessage: 'Regional Carbon Intensity (ton/kWh)',
|
|
}),
|
|
value: 0.000379069,
|
|
description: i18n.translate('xpack.observability.profilingCo2PerKWHUiSettingDescription', {
|
|
defaultMessage: `Carbon intensity measures how clean your data center electricity is.
|
|
Specifically, it measures the average amount of CO2 emitted per kilowatt-hour (kWh) of electricity consumed in a particular region.
|
|
Use the cloud carbon footprint {datasheetLink} to update this value according to your region. Defaults to US East (N. Virginia).`,
|
|
values: {
|
|
datasheetLink:
|
|
'<a href="https://ela.st/grid-datasheet" target="_blank" rel="noopener noreferrer">' +
|
|
i18n.translate(
|
|
'xpack.observability.profilingCo2PerKWHUiSettingDescription.datasheetLink',
|
|
{ defaultMessage: 'datasheet' }
|
|
) +
|
|
'</a>',
|
|
},
|
|
}),
|
|
schema: schema.number({ min: 0 }),
|
|
requiresPageReload: false,
|
|
},
|
|
};
|
|
|
|
function throttlingDocsLink({ href }: { href: string }) {
|
|
return `<a href="${href}" target="_blank" rel="noopener noreferrer">${i18n.translate(
|
|
'xpack.observability.uiSettings.throttlingDocsLinkText',
|
|
{ defaultMessage: 'read notice here.' }
|
|
)}</a>`;
|
|
}
|
|
|
|
function traceExplorerDocsLink({ href }: { href: string }) {
|
|
return `<a href="${href}" target="_blank">${i18n.translate(
|
|
'xpack.observability.uiSettings.traceExplorerDocsLinkText',
|
|
{ defaultMessage: 'Learn more.' }
|
|
)}</a>`;
|
|
}
|