Skip to content

Commit d91af7a

Browse files
lcawlflorent-leborgne
lcawl
and
florent-leborgne
authored
[DOCS] Update URLs for apm, monitoring, and observability (#218030)
Co-authored-by: florent-leborgne <[email protected]>
1 parent 96d1692 commit d91af7a

File tree

4 files changed

+53
-91
lines changed

4 files changed

+53
-91
lines changed

‎oas_docs/output/kibana.yaml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -277,7 +277,7 @@ tags:
277277
x-displayName: Upgrade assistant
278278
- externalDocs:
279279
description: Uptime monitoring
280-
url: https://www.elastic.co/guide/en/observability/current/uptime-intro.html
280+
url: https://www.elastic.co/docs/solutions/observability/uptime
281281
name: uptime
282282
x-displayName: Uptime
283283
- name: user session

‎src/platform/packages/shared/kbn-doc-links/src/get_doc_links.ts‎

Lines changed: 50 additions & 88 deletions
Original file line numberDiff line numberDiff line change
@@ -34,8 +34,6 @@ export const getDocLinks = ({ kibanaBranch, buildFlavor }: GetDocLinkOptions): D
3434
const KIBANA_APIS = `${API_DOCS}doc/kibana/`;
3535
const KIBANA_SERVERLESS_APIS = `{$API_DOCS}doc/serverless/`;
3636
const FLEET_DOCS = `${ELASTIC_WEBSITE_URL}guide/en/fleet/${DOC_LINK_VERSION}/`;
37-
const INTEGRATIONS_DEV_DOCS = `${ELASTIC_WEBSITE_URL}guide/en/integrations-developer/current/`;
38-
const OBSERVABILITY_DOCS = `${ELASTIC_WEBSITE_URL}guide/en/observability/${DOC_LINK_VERSION}/`;
3937
const SECURITY_SOLUTION_DOCS = `${ELASTIC_WEBSITE_URL}guide/en/security/${DOC_LINK_VERSION}/`;
4038
const ENTERPRISE_SEARCH_DOCS = `${ELASTIC_WEBSITE_URL}guide/en/enterprise-search/${DOC_LINK_VERSION}/`;
4139
const ESRE_DOCS = `${ELASTIC_WEBSITE_URL}guide/en/esre/${DOC_LINK_VERSION}/`;
@@ -54,29 +52,19 @@ export const getDocLinks = ({ kibanaBranch, buildFlavor }: GetDocLinkOptions): D
5452
upgradingStackOnCloud: `${ELASTIC_DOCS}deploy-manage/upgrade/deployment-or-cluster`,
5553
},
5654
apm: {
57-
kibanaSettings: `${KIBANA_DOCS}apm-settings-in-kibana.html`,
58-
supportedServiceMaps: isServerless
59-
? `${SERVERLESS_DOCS}observability-apm-service-map.html#observability-apm-service-map-supported-apm-agents`
60-
: `${KIBANA_DOCS}service-maps.html#service-maps-supported`,
61-
customLinks: isServerless
62-
? `${SERVERLESS_DOCS}observability-apm-create-custom-links.html`
63-
: `${KIBANA_DOCS}custom-links.html`,
64-
droppedTransactionSpans: `${OBSERVABILITY_DOCS}apm-data-model-spans.html#apm-data-model-dropped-spans`,
65-
upgrading: `${OBSERVABILITY_DOCS}apm-upgrade.html`,
66-
metaData: `${OBSERVABILITY_DOCS}apm-data-model-metadata.html`,
67-
overview: `${OBSERVABILITY_DOCS}apm.html`,
68-
tailSamplingPolicies: isServerless
69-
? `${SERVERLESS_DOCS}observability-apm-transaction-sampling.html`
70-
: `${OBSERVABILITY_DOCS}configure-tail-based-sampling.html`,
71-
elasticAgent: `${OBSERVABILITY_DOCS}/apm-upgrade-to-apm-integration.html`,
72-
storageExplorer: `${KIBANA_DOCS}storage-explorer.html`,
73-
spanCompression: isServerless
74-
? `${SERVERLESS_DOCS}observability-apm-compress-spans.html`
75-
: `${OBSERVABILITY_DOCS}apm-data-model-spans.html#apm-spans-span-compression`,
76-
transactionSampling: isServerless
77-
? `${SERVERLESS_DOCS}observability-apm-transaction-sampling.html`
78-
: `${OBSERVABILITY_DOCS}sampling.html`,
79-
indexLifecycleManagement: `${OBSERVABILITY_DOCS}apm-ilm-how-to.html`,
55+
kibanaSettings: `${ELASTIC_DOCS}solutions/observability/apm/applications-ui-settings`,
56+
supportedServiceMaps: `${ELASTIC_DOCS}solutions/observability/apm/service-map`,
57+
customLinks: `${ELASTIC_DOCS}solutions/observability/apm/create-custom-links`,
58+
droppedTransactionSpans: `${ELASTIC_DOCS}solutions/observability/apm/spans#apm-data-model-dropped-spans`,
59+
upgrading: `${ELASTIC_DOCS}solutions/observability/apm/upgrade`,
60+
metaData: `${ELASTIC_DOCS}solutions/observability/apm/metadata`,
61+
overview: `${ELASTIC_DOCS}solutions/observability/apm`,
62+
tailSamplingPolicies: `${ELASTIC_DOCS}solutions/observability/apm/transaction-sampling`,
63+
elasticAgent: `${ELASTIC_DOCS}solutions/observability/apm/switch-to-elastic-apm-integration`,
64+
storageExplorer: `${ELASTIC_DOCS}solutions/observability/apm/storage-explorer`,
65+
spanCompression: `${ELASTIC_DOCS}solutions/observability/apm/spans`,
66+
transactionSampling: `${ELASTIC_DOCS}solutions/observability/apm/transaction-sampling`,
67+
indexLifecycleManagement: `${ELASTIC_DOCS}solutions/observability/apm/index-lifecycle-management`,
8068
},
8169
canvas: {
8270
guide: `${ELASTIC_DOCS}explore-analyze/visualize/canvas`,
@@ -584,51 +572,27 @@ export const getDocLinks = ({ kibanaBranch, buildFlavor }: GetDocLinkOptions): D
584572
tsvbIndexPatternMode: `${ELASTIC_DOCS}explore-analyze/visualize/legacy-editors/tsvb#tsvb-data-view-mode`,
585573
},
586574
observability: {
587-
guide: isServerless
588-
? `${SERVERLESS_DOCS}what-is-observability-serverless.html`
589-
: `${OBSERVABILITY_DOCS}index.html`,
590-
infrastructureThreshold: `${OBSERVABILITY_DOCS}infrastructure-threshold-alert.html`,
591-
logsThreshold: `${OBSERVABILITY_DOCS}logs-threshold-alert.html`,
592-
metricsThreshold: `${OBSERVABILITY_DOCS}metrics-threshold-alert.html`,
593-
customThreshold: isServerless
594-
? `${SERVERLESS_DOCS}observability-create-custom-threshold-alert-rule.html`
595-
: `${OBSERVABILITY_DOCS}custom-threshold-alert.html`,
596-
monitorStatus: `${OBSERVABILITY_DOCS}monitor-status-alert.html`,
597-
monitorUptime: isServerless
598-
? `${SERVERLESS_DOCS}observability-monitor-synthetics.html`
599-
: `${OBSERVABILITY_DOCS}monitor-uptime.html`,
600-
tlsCertificate: `${OBSERVABILITY_DOCS}tls-certificate-alert.html`,
601-
uptimeDurationAnomaly: `${OBSERVABILITY_DOCS}duration-anomaly-alert.html`,
602-
monitorLogs: isServerless
603-
? `${SERVERLESS_DOCS}observability-discover-and-explore-logs.html`
604-
: `${OBSERVABILITY_DOCS}monitor-logs.html`,
605-
analyzeMetrics: isServerless
606-
? `${SERVERLESS_DOCS}observability-infrastructure-monitoring.html`
607-
: `${OBSERVABILITY_DOCS}analyze-metrics.html`,
608-
monitorUptimeSynthetics: isServerless
609-
? `${SERVERLESS_DOCS}observability-monitor-synthetics.html`
610-
: `${OBSERVABILITY_DOCS}monitor-uptime-synthetics.html`,
611-
userExperience: `${OBSERVABILITY_DOCS}user-experience.html`,
612-
createAlerts: isServerless
613-
? `${SERVERLESS_DOCS}observability-alerting.html`
614-
: `${OBSERVABILITY_DOCS}create-alerts.html`,
615-
syntheticsAlerting: isServerless
616-
? `${SERVERLESS_DOCS}observability-synthetics-settings.html#synthetics-settings-alerting`
617-
: `${OBSERVABILITY_DOCS}synthetics-settings.html#synthetics-settings-alerting`,
618-
syntheticsCommandReference: isServerless
619-
? `${SERVERLESS_DOCS}observability-synthetics-configuration.html#synthetics-configuration-playwright-options`
620-
: `${OBSERVABILITY_DOCS}synthetics-configuration.html#synthetics-configuration-playwright-options`,
621-
syntheticsProjectMonitors: isServerless
622-
? `${SERVERLESS_DOCS}observability-synthetics-get-started-project.html`
623-
: `${OBSERVABILITY_DOCS}synthetic-run-tests.html#synthetic-monitor-choose-project`,
624-
syntheticsMigrateFromIntegration: `${OBSERVABILITY_DOCS}synthetics-migrate-from-integration.html`,
625-
slo: isServerless
626-
? `${SERVERLESS_DOCS}observability-slos.html`
627-
: `${OBSERVABILITY_DOCS}slo.html`,
628-
sloBurnRateRule: isServerless
629-
? `${SERVERLESS_DOCS}observability-create-slo-burn-rate-alert-rule.html`
630-
: `${OBSERVABILITY_DOCS}slo-burn-rate-alert.html`,
631-
aiAssistant: `${OBSERVABILITY_DOCS}obs-ai-assistant.html`,
575+
guide: `${ELASTIC_DOCS}solutions/observability`,
576+
infrastructureThreshold: `${ELASTIC_DOCS}solutions/observability/incident-management/create-an-inventory-rule`,
577+
logsThreshold: `${ELASTIC_DOCS}solutions/observability/incident-management/create-log-threshold-rule`,
578+
metricsThreshold: `${ELASTIC_DOCS}solutions/observability/incident-management/create-metric-threshold-rule`,
579+
customThreshold: `${ELASTIC_DOCS}solutions/observability/incident-management/create-custom-threshold-rule`,
580+
monitorStatus: `${ELASTIC_DOCS}solutions/observability/incident-management/create-monitor-status-rule`,
581+
monitorUptime: `${ELASTIC_DOCS}solutions/observability/synthetics`,
582+
tlsCertificate: `${ELASTIC_DOCS}solutions/observability/incident-management/create-tls-certificate-rule`,
583+
uptimeDurationAnomaly: `${ELASTIC_DOCS}solutions/observability/incident-management/create-an-uptime-duration-anomaly-rule`,
584+
monitorLogs: `${ELASTIC_DOCS}solutions/observability/logs/explore-logs`,
585+
analyzeMetrics: `${ELASTIC_DOCS}solutions/observability/infra-and-hosts/analyze-infrastructure-host-metrics`,
586+
monitorUptimeSynthetics: `${ELASTIC_DOCS}solutions/observability/synthetics`,
587+
userExperience: `${ELASTIC_DOCS}solutions/observability/applications/user-experience`,
588+
createAlerts: `${ELASTIC_DOCS}solutions/observability/incident-management/alerting`,
589+
syntheticsAlerting: `${ELASTIC_DOCS}solutions/observability/synthetics/configure-settings#synthetics-settings-alerting`,
590+
syntheticsCommandReference: `${ELASTIC_DOCS}solutions/observability/synthetics/configure-projects#synthetics-configuration-playwright-options`,
591+
syntheticsProjectMonitors: `${ELASTIC_DOCS}solutions/observability/synthetics/create-monitors-with-projects`,
592+
syntheticsMigrateFromIntegration: `${ELASTIC_DOCS}solutions/observability/synthetics/migrate-from-elastic-synthetics-integration`,
593+
slo: `${ELASTIC_DOCS}solutions/observability/incident-management/service-level-objectives-slos`,
594+
sloBurnRateRule: `${ELASTIC_DOCS}solutions/observability/incident-management/create-an-slo-burn-rate-rule`,
595+
aiAssistant: `${ELASTIC_DOCS}solutions/observability/observability-ai-assistant`,
632596
},
633597
alerting: {
634598
guide: `${ELASTIC_DOCS}explore-analyze/alerts-cases/alerts/create-manage-rules`,
@@ -669,20 +633,20 @@ export const getDocLinks = ({ kibanaBranch, buildFlavor }: GetDocLinkOptions): D
669633
termJoinsExample: `${ELASTIC_DOCS}explore-analyze/visualize/maps/terms-join#_example_term_join`,
670634
},
671635
monitoring: {
672-
alertsKibana: `${KIBANA_DOCS}kibana-alerts.html`,
673-
alertsKibanaCpuThreshold: `${KIBANA_DOCS}kibana-alerts.html#kibana-alerts-cpu-threshold`,
674-
alertsKibanaDiskThreshold: `${KIBANA_DOCS}kibana-alerts.html#kibana-alerts-disk-usage-threshold`,
675-
alertsKibanaJvmThreshold: `${KIBANA_DOCS}kibana-alerts.html#kibana-alerts-jvm-memory-threshold`,
676-
alertsKibanaMissingData: `${KIBANA_DOCS}kibana-alerts.html#kibana-alerts-missing-monitoring-data`,
677-
alertsKibanaThreadpoolRejections: `${KIBANA_DOCS}kibana-alerts.html#kibana-alerts-thread-pool-rejections`,
678-
alertsKibanaCCRReadExceptions: `${KIBANA_DOCS}kibana-alerts.html#kibana-alerts-ccr-read-exceptions`,
679-
alertsKibanaLargeShardSize: `${KIBANA_DOCS}kibana-alerts.html#kibana-alerts-large-shard-size`,
680-
alertsKibanaClusterAlerts: `${KIBANA_DOCS}kibana-alerts.html#kibana-alerts-cluster-alerts`,
681-
metricbeatBlog: `${ELASTIC_WEBSITE_URL}blog/external-collection-for-elastic-stack-monitoring-is-now-available-via-metricbeat`,
682-
monitorElasticsearch: `${ELASTICSEARCH_DOCS}configuring-metricbeat.html`,
683-
monitorKibana: `${KIBANA_DOCS}monitoring-metricbeat.html`,
684-
monitorLogstash: `${ELASTIC_WEBSITE_URL}guide/en/logstash/${DOC_LINK_VERSION}/monitoring-with-metricbeat.html`,
685-
troubleshootKibana: `${KIBANA_DOCS}monitor-troubleshooting.html`,
636+
alertsKibana: `${ELASTIC_DOCS}deploy-manage/monitor/monitoring-data/configure-stack-monitoring-alerts`,
637+
alertsKibanaCpuThreshold: `${ELASTIC_DOCS}deploy-manage/monitor/monitoring-data/configure-stack-monitoring-alerts#kibana-alerts-cpu-threshold`,
638+
alertsKibanaDiskThreshold: `${ELASTIC_DOCS}deploy-manage/monitor/monitoring-data/configure-stack-monitoring-alerts#kibana-alerts-disk-usage-threshold`,
639+
alertsKibanaJvmThreshold: `${ELASTIC_DOCS}deploy-manage/monitor/monitoring-data/configure-stack-monitoring-alerts#kibana-alerts-jvm-memory-threshold`,
640+
alertsKibanaMissingData: `${ELASTIC_DOCS}deploy-manage/monitor/monitoring-data/configure-stack-monitoring-alerts#kibana-alerts-missing-monitoring-data`,
641+
alertsKibanaThreadpoolRejections: `${ELASTIC_DOCS}deploy-manage/monitor/monitoring-data/configure-stack-monitoring-alerts#kibana-alerts-thread-pool-rejections`,
642+
alertsKibanaCCRReadExceptions: `${ELASTIC_DOCS}deploy-manage/monitor/monitoring-data/configure-stack-monitoring-alerts#kibana-alerts-ccr-read-exceptions`,
643+
alertsKibanaLargeShardSize: `${ELASTIC_DOCS}deploy-manage/monitor/monitoring-data/configure-stack-monitoring-alerts#kibana-alerts-large-shard-size`,
644+
alertsKibanaClusterAlerts: `${ELASTIC_DOCS}deploy-manage/monitor/monitoring-data/configure-stack-monitoring-alerts#kibana-alerts-cluster-alerts`,
645+
metricbeatBlog: `https://www.elastic.co/blog/external-collection-for-elastic-stack-monitoring-is-now-available-via-metricbeat`,
646+
monitorElasticsearch: `${ELASTIC_DOCS}deploy-manage/monitor/stack-monitoring/collecting-monitoring-data-with-metricbeat`,
647+
monitorKibana: `${ELASTIC_DOCS}deploy-manage/monitor/stack-monitoring/kibana-monitoring-metricbeat`,
648+
monitorLogstash: `${ELASTIC_DOCS}reference/logstash/monitoring-with-metricbeat`,
649+
troubleshootKibana: `${ELASTIC_DOCS}troubleshoot/kibana/monitoring`,
686650
},
687651
reporting: {
688652
cloudMinimumRequirements: `${ELASTIC_DOCS}explore-analyze/report-and-share#_embed_outside_of_kib`,
@@ -916,7 +880,7 @@ export const getDocLinks = ({ kibanaBranch, buildFlavor }: GetDocLinkOptions): D
916880
agentLevelLogging: `${FLEET_DOCS}monitor-elastic-agent.html#change-logging-level`,
917881
},
918882
integrationDeveloper: {
919-
upload: `${INTEGRATIONS_DEV_DOCS}upload-a-new-integration.html`,
883+
upload: `${ELASTIC_DOCS}extend/integrations/upload-new-integration`,
920884
},
921885
ecs: {
922886
guide: `${ELASTIC_DOCS}reference/ecs`,
@@ -1013,9 +977,7 @@ export const getDocLinks = ({ kibanaBranch, buildFlavor }: GetDocLinkOptions): D
1013977
apiKeyPrivileges: `${ELASTIC_DOCS}deploy-manage/api-keys/serverless-project-api-keys#api-keys-restrict-privileges`,
1014978
},
1015979
synthetics: {
1016-
featureRoles: isServerless
1017-
? `${SERVERLESS_DOCS}observability-synthetics-feature-roles.html`
1018-
: `${OBSERVABILITY_DOCS}synthetics-feature-roles.html`,
980+
featureRoles: `${ELASTIC_DOCS}solutions/observability/synthetics/grant-access-to-secured-resources`,
1019981
},
1020982
telemetry: {
1021983
settings: `${ELASTIC_DOCS}reference/kibana/configuration-reference/telemetry-settings`,

‎src/platform/plugins/shared/ai_assistant_management/selection/public/routes/components/ai_assistant_selection_page.test.tsx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ describe('AiAssistantSelectionPage', () => {
9595
renderComponent(testCapabilities);
9696
const docLink = screen.getByTestId('pluginsAiAssistantSelectionPageDocumentationLink');
9797
expect(docLink).toBeInTheDocument();
98-
expect(docLink.getAttribute('href')).toContain('obs-ai-assistant');
98+
expect(docLink.getAttribute('href')).toContain('observability-ai-assistant');
9999
});
100100
});
101101
});

‎x-pack/solutions/observability/plugins/uptime/docs/openapi/uptime_apis.yaml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ tags:
1111
x-displayName: Uptime
1212
# description:
1313
externalDocs:
14-
url: https://www.elastic.co/guide/en/observability/current/uptime-intro.html
14+
url: https://www.elastic.co/docs/solutions/observability/uptime
1515
description: Uptime monitoring
1616
servers:
1717
- url: /

0 commit comments

Comments
 (0)