[DOCS] Update URLs for apm, monitoring, and observability (#218030)

Co-authored-by: florent-leborgne <florent.leborgne@elastic.co>
This commit is contained in:
Lisa Cawley 2025-05-08 17:29:43 -07:00 committed by GitHub
parent 96d1692ae2
commit d91af7ad7d
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
4 changed files with 53 additions and 91 deletions

View file

@ -277,7 +277,7 @@ tags:
x-displayName: Upgrade assistant
- externalDocs:
description: Uptime monitoring
url: https://www.elastic.co/guide/en/observability/current/uptime-intro.html
url: https://www.elastic.co/docs/solutions/observability/uptime
name: uptime
x-displayName: Uptime
- name: user session

View file

@ -34,8 +34,6 @@ export const getDocLinks = ({ kibanaBranch, buildFlavor }: GetDocLinkOptions): D
const KIBANA_APIS = `${API_DOCS}doc/kibana/`;
const KIBANA_SERVERLESS_APIS = `{$API_DOCS}doc/serverless/`;
const FLEET_DOCS = `${ELASTIC_WEBSITE_URL}guide/en/fleet/${DOC_LINK_VERSION}/`;
const INTEGRATIONS_DEV_DOCS = `${ELASTIC_WEBSITE_URL}guide/en/integrations-developer/current/`;
const OBSERVABILITY_DOCS = `${ELASTIC_WEBSITE_URL}guide/en/observability/${DOC_LINK_VERSION}/`;
const SECURITY_SOLUTION_DOCS = `${ELASTIC_WEBSITE_URL}guide/en/security/${DOC_LINK_VERSION}/`;
const ENTERPRISE_SEARCH_DOCS = `${ELASTIC_WEBSITE_URL}guide/en/enterprise-search/${DOC_LINK_VERSION}/`;
const ESRE_DOCS = `${ELASTIC_WEBSITE_URL}guide/en/esre/${DOC_LINK_VERSION}/`;
@ -54,29 +52,19 @@ export const getDocLinks = ({ kibanaBranch, buildFlavor }: GetDocLinkOptions): D
upgradingStackOnCloud: `${ELASTIC_DOCS}deploy-manage/upgrade/deployment-or-cluster`,
},
apm: {
kibanaSettings: `${KIBANA_DOCS}apm-settings-in-kibana.html`,
supportedServiceMaps: isServerless
? `${SERVERLESS_DOCS}observability-apm-service-map.html#observability-apm-service-map-supported-apm-agents`
: `${KIBANA_DOCS}service-maps.html#service-maps-supported`,
customLinks: isServerless
? `${SERVERLESS_DOCS}observability-apm-create-custom-links.html`
: `${KIBANA_DOCS}custom-links.html`,
droppedTransactionSpans: `${OBSERVABILITY_DOCS}apm-data-model-spans.html#apm-data-model-dropped-spans`,
upgrading: `${OBSERVABILITY_DOCS}apm-upgrade.html`,
metaData: `${OBSERVABILITY_DOCS}apm-data-model-metadata.html`,
overview: `${OBSERVABILITY_DOCS}apm.html`,
tailSamplingPolicies: isServerless
? `${SERVERLESS_DOCS}observability-apm-transaction-sampling.html`
: `${OBSERVABILITY_DOCS}configure-tail-based-sampling.html`,
elasticAgent: `${OBSERVABILITY_DOCS}/apm-upgrade-to-apm-integration.html`,
storageExplorer: `${KIBANA_DOCS}storage-explorer.html`,
spanCompression: isServerless
? `${SERVERLESS_DOCS}observability-apm-compress-spans.html`
: `${OBSERVABILITY_DOCS}apm-data-model-spans.html#apm-spans-span-compression`,
transactionSampling: isServerless
? `${SERVERLESS_DOCS}observability-apm-transaction-sampling.html`
: `${OBSERVABILITY_DOCS}sampling.html`,
indexLifecycleManagement: `${OBSERVABILITY_DOCS}apm-ilm-how-to.html`,
kibanaSettings: `${ELASTIC_DOCS}solutions/observability/apm/applications-ui-settings`,
supportedServiceMaps: `${ELASTIC_DOCS}solutions/observability/apm/service-map`,
customLinks: `${ELASTIC_DOCS}solutions/observability/apm/create-custom-links`,
droppedTransactionSpans: `${ELASTIC_DOCS}solutions/observability/apm/spans#apm-data-model-dropped-spans`,
upgrading: `${ELASTIC_DOCS}solutions/observability/apm/upgrade`,
metaData: `${ELASTIC_DOCS}solutions/observability/apm/metadata`,
overview: `${ELASTIC_DOCS}solutions/observability/apm`,
tailSamplingPolicies: `${ELASTIC_DOCS}solutions/observability/apm/transaction-sampling`,
elasticAgent: `${ELASTIC_DOCS}solutions/observability/apm/switch-to-elastic-apm-integration`,
storageExplorer: `${ELASTIC_DOCS}solutions/observability/apm/storage-explorer`,
spanCompression: `${ELASTIC_DOCS}solutions/observability/apm/spans`,
transactionSampling: `${ELASTIC_DOCS}solutions/observability/apm/transaction-sampling`,
indexLifecycleManagement: `${ELASTIC_DOCS}solutions/observability/apm/index-lifecycle-management`,
},
canvas: {
guide: `${ELASTIC_DOCS}explore-analyze/visualize/canvas`,
@ -584,51 +572,27 @@ export const getDocLinks = ({ kibanaBranch, buildFlavor }: GetDocLinkOptions): D
tsvbIndexPatternMode: `${ELASTIC_DOCS}explore-analyze/visualize/legacy-editors/tsvb#tsvb-data-view-mode`,
},
observability: {
guide: isServerless
? `${SERVERLESS_DOCS}what-is-observability-serverless.html`
: `${OBSERVABILITY_DOCS}index.html`,
infrastructureThreshold: `${OBSERVABILITY_DOCS}infrastructure-threshold-alert.html`,
logsThreshold: `${OBSERVABILITY_DOCS}logs-threshold-alert.html`,
metricsThreshold: `${OBSERVABILITY_DOCS}metrics-threshold-alert.html`,
customThreshold: isServerless
? `${SERVERLESS_DOCS}observability-create-custom-threshold-alert-rule.html`
: `${OBSERVABILITY_DOCS}custom-threshold-alert.html`,
monitorStatus: `${OBSERVABILITY_DOCS}monitor-status-alert.html`,
monitorUptime: isServerless
? `${SERVERLESS_DOCS}observability-monitor-synthetics.html`
: `${OBSERVABILITY_DOCS}monitor-uptime.html`,
tlsCertificate: `${OBSERVABILITY_DOCS}tls-certificate-alert.html`,
uptimeDurationAnomaly: `${OBSERVABILITY_DOCS}duration-anomaly-alert.html`,
monitorLogs: isServerless
? `${SERVERLESS_DOCS}observability-discover-and-explore-logs.html`
: `${OBSERVABILITY_DOCS}monitor-logs.html`,
analyzeMetrics: isServerless
? `${SERVERLESS_DOCS}observability-infrastructure-monitoring.html`
: `${OBSERVABILITY_DOCS}analyze-metrics.html`,
monitorUptimeSynthetics: isServerless
? `${SERVERLESS_DOCS}observability-monitor-synthetics.html`
: `${OBSERVABILITY_DOCS}monitor-uptime-synthetics.html`,
userExperience: `${OBSERVABILITY_DOCS}user-experience.html`,
createAlerts: isServerless
? `${SERVERLESS_DOCS}observability-alerting.html`
: `${OBSERVABILITY_DOCS}create-alerts.html`,
syntheticsAlerting: isServerless
? `${SERVERLESS_DOCS}observability-synthetics-settings.html#synthetics-settings-alerting`
: `${OBSERVABILITY_DOCS}synthetics-settings.html#synthetics-settings-alerting`,
syntheticsCommandReference: isServerless
? `${SERVERLESS_DOCS}observability-synthetics-configuration.html#synthetics-configuration-playwright-options`
: `${OBSERVABILITY_DOCS}synthetics-configuration.html#synthetics-configuration-playwright-options`,
syntheticsProjectMonitors: isServerless
? `${SERVERLESS_DOCS}observability-synthetics-get-started-project.html`
: `${OBSERVABILITY_DOCS}synthetic-run-tests.html#synthetic-monitor-choose-project`,
syntheticsMigrateFromIntegration: `${OBSERVABILITY_DOCS}synthetics-migrate-from-integration.html`,
slo: isServerless
? `${SERVERLESS_DOCS}observability-slos.html`
: `${OBSERVABILITY_DOCS}slo.html`,
sloBurnRateRule: isServerless
? `${SERVERLESS_DOCS}observability-create-slo-burn-rate-alert-rule.html`
: `${OBSERVABILITY_DOCS}slo-burn-rate-alert.html`,
aiAssistant: `${OBSERVABILITY_DOCS}obs-ai-assistant.html`,
guide: `${ELASTIC_DOCS}solutions/observability`,
infrastructureThreshold: `${ELASTIC_DOCS}solutions/observability/incident-management/create-an-inventory-rule`,
logsThreshold: `${ELASTIC_DOCS}solutions/observability/incident-management/create-log-threshold-rule`,
metricsThreshold: `${ELASTIC_DOCS}solutions/observability/incident-management/create-metric-threshold-rule`,
customThreshold: `${ELASTIC_DOCS}solutions/observability/incident-management/create-custom-threshold-rule`,
monitorStatus: `${ELASTIC_DOCS}solutions/observability/incident-management/create-monitor-status-rule`,
monitorUptime: `${ELASTIC_DOCS}solutions/observability/synthetics`,
tlsCertificate: `${ELASTIC_DOCS}solutions/observability/incident-management/create-tls-certificate-rule`,
uptimeDurationAnomaly: `${ELASTIC_DOCS}solutions/observability/incident-management/create-an-uptime-duration-anomaly-rule`,
monitorLogs: `${ELASTIC_DOCS}solutions/observability/logs/explore-logs`,
analyzeMetrics: `${ELASTIC_DOCS}solutions/observability/infra-and-hosts/analyze-infrastructure-host-metrics`,
monitorUptimeSynthetics: `${ELASTIC_DOCS}solutions/observability/synthetics`,
userExperience: `${ELASTIC_DOCS}solutions/observability/applications/user-experience`,
createAlerts: `${ELASTIC_DOCS}solutions/observability/incident-management/alerting`,
syntheticsAlerting: `${ELASTIC_DOCS}solutions/observability/synthetics/configure-settings#synthetics-settings-alerting`,
syntheticsCommandReference: `${ELASTIC_DOCS}solutions/observability/synthetics/configure-projects#synthetics-configuration-playwright-options`,
syntheticsProjectMonitors: `${ELASTIC_DOCS}solutions/observability/synthetics/create-monitors-with-projects`,
syntheticsMigrateFromIntegration: `${ELASTIC_DOCS}solutions/observability/synthetics/migrate-from-elastic-synthetics-integration`,
slo: `${ELASTIC_DOCS}solutions/observability/incident-management/service-level-objectives-slos`,
sloBurnRateRule: `${ELASTIC_DOCS}solutions/observability/incident-management/create-an-slo-burn-rate-rule`,
aiAssistant: `${ELASTIC_DOCS}solutions/observability/observability-ai-assistant`,
},
alerting: {
guide: `${ELASTIC_DOCS}explore-analyze/alerts-cases/alerts/create-manage-rules`,
@ -669,20 +633,20 @@ export const getDocLinks = ({ kibanaBranch, buildFlavor }: GetDocLinkOptions): D
termJoinsExample: `${ELASTIC_DOCS}explore-analyze/visualize/maps/terms-join#_example_term_join`,
},
monitoring: {
alertsKibana: `${KIBANA_DOCS}kibana-alerts.html`,
alertsKibanaCpuThreshold: `${KIBANA_DOCS}kibana-alerts.html#kibana-alerts-cpu-threshold`,
alertsKibanaDiskThreshold: `${KIBANA_DOCS}kibana-alerts.html#kibana-alerts-disk-usage-threshold`,
alertsKibanaJvmThreshold: `${KIBANA_DOCS}kibana-alerts.html#kibana-alerts-jvm-memory-threshold`,
alertsKibanaMissingData: `${KIBANA_DOCS}kibana-alerts.html#kibana-alerts-missing-monitoring-data`,
alertsKibanaThreadpoolRejections: `${KIBANA_DOCS}kibana-alerts.html#kibana-alerts-thread-pool-rejections`,
alertsKibanaCCRReadExceptions: `${KIBANA_DOCS}kibana-alerts.html#kibana-alerts-ccr-read-exceptions`,
alertsKibanaLargeShardSize: `${KIBANA_DOCS}kibana-alerts.html#kibana-alerts-large-shard-size`,
alertsKibanaClusterAlerts: `${KIBANA_DOCS}kibana-alerts.html#kibana-alerts-cluster-alerts`,
metricbeatBlog: `${ELASTIC_WEBSITE_URL}blog/external-collection-for-elastic-stack-monitoring-is-now-available-via-metricbeat`,
monitorElasticsearch: `${ELASTICSEARCH_DOCS}configuring-metricbeat.html`,
monitorKibana: `${KIBANA_DOCS}monitoring-metricbeat.html`,
monitorLogstash: `${ELASTIC_WEBSITE_URL}guide/en/logstash/${DOC_LINK_VERSION}/monitoring-with-metricbeat.html`,
troubleshootKibana: `${KIBANA_DOCS}monitor-troubleshooting.html`,
alertsKibana: `${ELASTIC_DOCS}deploy-manage/monitor/monitoring-data/configure-stack-monitoring-alerts`,
alertsKibanaCpuThreshold: `${ELASTIC_DOCS}deploy-manage/monitor/monitoring-data/configure-stack-monitoring-alerts#kibana-alerts-cpu-threshold`,
alertsKibanaDiskThreshold: `${ELASTIC_DOCS}deploy-manage/monitor/monitoring-data/configure-stack-monitoring-alerts#kibana-alerts-disk-usage-threshold`,
alertsKibanaJvmThreshold: `${ELASTIC_DOCS}deploy-manage/monitor/monitoring-data/configure-stack-monitoring-alerts#kibana-alerts-jvm-memory-threshold`,
alertsKibanaMissingData: `${ELASTIC_DOCS}deploy-manage/monitor/monitoring-data/configure-stack-monitoring-alerts#kibana-alerts-missing-monitoring-data`,
alertsKibanaThreadpoolRejections: `${ELASTIC_DOCS}deploy-manage/monitor/monitoring-data/configure-stack-monitoring-alerts#kibana-alerts-thread-pool-rejections`,
alertsKibanaCCRReadExceptions: `${ELASTIC_DOCS}deploy-manage/monitor/monitoring-data/configure-stack-monitoring-alerts#kibana-alerts-ccr-read-exceptions`,
alertsKibanaLargeShardSize: `${ELASTIC_DOCS}deploy-manage/monitor/monitoring-data/configure-stack-monitoring-alerts#kibana-alerts-large-shard-size`,
alertsKibanaClusterAlerts: `${ELASTIC_DOCS}deploy-manage/monitor/monitoring-data/configure-stack-monitoring-alerts#kibana-alerts-cluster-alerts`,
metricbeatBlog: `https://www.elastic.co/blog/external-collection-for-elastic-stack-monitoring-is-now-available-via-metricbeat`,
monitorElasticsearch: `${ELASTIC_DOCS}deploy-manage/monitor/stack-monitoring/collecting-monitoring-data-with-metricbeat`,
monitorKibana: `${ELASTIC_DOCS}deploy-manage/monitor/stack-monitoring/kibana-monitoring-metricbeat`,
monitorLogstash: `${ELASTIC_DOCS}reference/logstash/monitoring-with-metricbeat`,
troubleshootKibana: `${ELASTIC_DOCS}troubleshoot/kibana/monitoring`,
},
reporting: {
cloudMinimumRequirements: `${ELASTIC_DOCS}explore-analyze/report-and-share#_embed_outside_of_kib`,
@ -916,7 +880,7 @@ export const getDocLinks = ({ kibanaBranch, buildFlavor }: GetDocLinkOptions): D
agentLevelLogging: `${FLEET_DOCS}monitor-elastic-agent.html#change-logging-level`,
},
integrationDeveloper: {
upload: `${INTEGRATIONS_DEV_DOCS}upload-a-new-integration.html`,
upload: `${ELASTIC_DOCS}extend/integrations/upload-new-integration`,
},
ecs: {
guide: `${ELASTIC_DOCS}reference/ecs`,
@ -1013,9 +977,7 @@ export const getDocLinks = ({ kibanaBranch, buildFlavor }: GetDocLinkOptions): D
apiKeyPrivileges: `${ELASTIC_DOCS}deploy-manage/api-keys/serverless-project-api-keys#api-keys-restrict-privileges`,
},
synthetics: {
featureRoles: isServerless
? `${SERVERLESS_DOCS}observability-synthetics-feature-roles.html`
: `${OBSERVABILITY_DOCS}synthetics-feature-roles.html`,
featureRoles: `${ELASTIC_DOCS}solutions/observability/synthetics/grant-access-to-secured-resources`,
},
telemetry: {
settings: `${ELASTIC_DOCS}reference/kibana/configuration-reference/telemetry-settings`,

View file

@ -95,7 +95,7 @@ describe('AiAssistantSelectionPage', () => {
renderComponent(testCapabilities);
const docLink = screen.getByTestId('pluginsAiAssistantSelectionPageDocumentationLink');
expect(docLink).toBeInTheDocument();
expect(docLink.getAttribute('href')).toContain('obs-ai-assistant');
expect(docLink.getAttribute('href')).toContain('observability-ai-assistant');
});
});
});

View file

@ -11,7 +11,7 @@ tags:
x-displayName: Uptime
# description:
externalDocs:
url: https://www.elastic.co/guide/en/observability/current/uptime-intro.html
url: https://www.elastic.co/docs/solutions/observability/uptime
description: Uptime monitoring
servers:
- url: /