github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-06-28 11:05:39 -04:00
Code Issues Projects Releases Packages Wiki Activity

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

Browse source 
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
Download patch file Download diff file Expand all files Collapse all files

2
oas_docs/output/kibana.yaml
View file

@ -277,7 +277,7 @@ tags:
x-displayName: Upgrade assistant x-displayName: Upgrade assistant
- externalDocs: - externalDocs:
description: Uptime monitoring 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 name: uptime
x-displayName: Uptime x-displayName: Uptime
- name: user session - name: user session

138
src/platform/packages/shared/kbn-doc-links/src/get_doc_links.ts
View file

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

2
src/platform/plugins/shared/ai_assistant_management/selection/public/routes/components/ai_assistant_selection_page.test.tsx
View file

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

2
x-pack/solutions/observability/plugins/uptime/docs/openapi/uptime_apis.yaml
View file

@ -11,7 +11,7 @@ tags:
x-displayName: Uptime x-displayName: Uptime
# description: # description:
externalDocs: 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 description: Uptime monitoring
servers: servers:
- url: / - url: /