From 4c84f82a66971026be477abc04dd152c5b6d2c27 Mon Sep 17 00:00:00 2001 From: Colleen McGinnis Date: Wed, 19 Mar 2025 19:15:18 -0500 Subject: [PATCH 1/6] remove unused substitutions --- docs/docset.yml | 476 ------------------------------------------------ 1 file changed, 476 deletions(-) diff --git a/docs/docset.yml b/docs/docset.yml index 87513e6866..337c192ef1 100644 --- a/docs/docset.yml +++ b/docs/docset.yml @@ -13,482 +13,6 @@ toc: - toc: reference - toc: release-notes subs: - ref: "https://www.elastic.co/guide/en/elasticsearch/reference/current" - ref-bare: "https://www.elastic.co/guide/en/elasticsearch/reference" - ref-8x: "https://www.elastic.co/guide/en/elasticsearch/reference/8.1" - ref-80: "https://www.elastic.co/guide/en/elasticsearch/reference/8.0" - ref-7x: "https://www.elastic.co/guide/en/elasticsearch/reference/7.17" - ref-70: "https://www.elastic.co/guide/en/elasticsearch/reference/7.0" - ref-60: "https://www.elastic.co/guide/en/elasticsearch/reference/6.0" - ref-64: "https://www.elastic.co/guide/en/elasticsearch/reference/6.4" - xpack-ref: "https://www.elastic.co/guide/en/x-pack/6.2" - logstash-ref: "https://www.elastic.co/guide/en/logstash/current" - kibana-ref: "https://www.elastic.co/guide/en/kibana/current" - kibana-ref-all: "https://www.elastic.co/guide/en/kibana" - beats-ref-root: "https://www.elastic.co/guide/en/beats" - beats-ref: "https://www.elastic.co/guide/en/beats/libbeat/current" - beats-ref-60: "https://www.elastic.co/guide/en/beats/libbeat/6.0" - beats-ref-63: "https://www.elastic.co/guide/en/beats/libbeat/6.3" - beats-devguide: "https://www.elastic.co/guide/en/beats/devguide/current" - auditbeat-ref: "https://www.elastic.co/guide/en/beats/auditbeat/current" - packetbeat-ref: "https://www.elastic.co/guide/en/beats/packetbeat/current" - metricbeat-ref: "https://www.elastic.co/guide/en/beats/metricbeat/current" - filebeat-ref: "https://www.elastic.co/guide/en/beats/filebeat/current" - functionbeat-ref: "https://www.elastic.co/guide/en/beats/functionbeat/current" - winlogbeat-ref: "https://www.elastic.co/guide/en/beats/winlogbeat/current" - heartbeat-ref: "https://www.elastic.co/guide/en/beats/heartbeat/current" - journalbeat-ref: "https://www.elastic.co/guide/en/beats/journalbeat/current" - ingest-guide: "https://www.elastic.co/guide/en/ingest/current" - fleet-guide: "https://www.elastic.co/guide/en/fleet/current" - apm-guide-ref: "https://www.elastic.co/guide/en/apm/guide/current" - apm-guide-7x: "https://www.elastic.co/guide/en/apm/guide/7.17" - apm-app-ref: "https://www.elastic.co/guide/en/kibana/current" - apm-agents-ref: "https://www.elastic.co/guide/en/apm/agent" - apm-android-ref: "https://www.elastic.co/guide/en/apm/agent/android/current" - apm-py-ref: "https://www.elastic.co/guide/en/apm/agent/python/current" - apm-py-ref-3x: "https://www.elastic.co/guide/en/apm/agent/python/3.x" - apm-node-ref-index: "https://www.elastic.co/guide/en/apm/agent/nodejs" - apm-node-ref: "https://www.elastic.co/guide/en/apm/agent/nodejs/current" - apm-node-ref-1x: "https://www.elastic.co/guide/en/apm/agent/nodejs/1.x" - apm-rum-ref: "https://www.elastic.co/guide/en/apm/agent/rum-js/current" - apm-ruby-ref: "https://www.elastic.co/guide/en/apm/agent/ruby/current" - apm-java-ref: "https://www.elastic.co/guide/en/apm/agent/java/current" - apm-go-ref: "https://www.elastic.co/guide/en/apm/agent/go/current" - apm-dotnet-ref: "https://www.elastic.co/guide/en/apm/agent/dotnet/current" - apm-php-ref: "https://www.elastic.co/guide/en/apm/agent/php/current" - apm-ios-ref: "https://www.elastic.co/guide/en/apm/agent/swift/current" - apm-lambda-ref: "https://www.elastic.co/guide/en/apm/lambda/current" - apm-attacher-ref: "https://www.elastic.co/guide/en/apm/attacher/current" - docker-logging-ref: "https://www.elastic.co/guide/en/beats/loggingplugin/current" - esf-ref: "https://www.elastic.co/guide/en/esf/current" - kinesis-firehose-ref: "https://www.elastic.co/guide/en/kinesis/{{kinesis_version}}" - estc-welcome-current: "https://www.elastic.co/guide/en/starting-with-the-elasticsearch-platform-and-its-solutions/current" - estc-welcome: "https://www.elastic.co/guide/en/starting-with-the-elasticsearch-platform-and-its-solutions/current" - estc-welcome-all: "https://www.elastic.co/guide/en/starting-with-the-elasticsearch-platform-and-its-solutions" - hadoop-ref: "https://www.elastic.co/guide/en/elasticsearch/hadoop/current" - stack-ref: "https://www.elastic.co/guide/en/elastic-stack/current" - stack-ref-67: "https://www.elastic.co/guide/en/elastic-stack/6.7" - stack-ref-68: "https://www.elastic.co/guide/en/elastic-stack/6.8" - stack-ref-70: "https://www.elastic.co/guide/en/elastic-stack/7.0" - stack-ref-80: "https://www.elastic.co/guide/en/elastic-stack/8.0" - stack-ov: "https://www.elastic.co/guide/en/elastic-stack-overview/current" - stack-gs: "https://www.elastic.co/guide/en/elastic-stack-get-started/current" - stack-gs-current: "https://www.elastic.co/guide/en/elastic-stack-get-started/current" - javaclient: "https://www.elastic.co/guide/en/elasticsearch/client/java-api/current" - java-api-client: "https://www.elastic.co/guide/en/elasticsearch/client/java-api-client/current" - java-rest: "https://www.elastic.co/guide/en/elasticsearch/client/java-rest/current" - jsclient: "https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current" - jsclient-current: "https://www.elastic.co/guide/en/elasticsearch/client/javascript-api/current" - es-ruby-client: "https://www.elastic.co/guide/en/elasticsearch/client/ruby-api/current" - es-dotnet-client: "https://www.elastic.co/guide/en/elasticsearch/client/net-api/current" - es-php-client: "https://www.elastic.co/guide/en/elasticsearch/client/php-api/current" - es-python-client: "https://www.elastic.co/guide/en/elasticsearch/client/python-api/current" - defguide: "https://www.elastic.co/guide/en/elasticsearch/guide/2.x" - painless: "https://www.elastic.co/guide/en/elasticsearch/painless/current" - plugins: "https://www.elastic.co/guide/en/elasticsearch/plugins/current" - plugins-8x: "https://www.elastic.co/guide/en/elasticsearch/plugins/8.1" - plugins-7x: "https://www.elastic.co/guide/en/elasticsearch/plugins/7.17" - plugins-6x: "https://www.elastic.co/guide/en/elasticsearch/plugins/6.8" - glossary: "https://www.elastic.co/guide/en/elastic-stack-glossary/current" - upgrade_guide: "https://www.elastic.co/products/upgrade_guide" - blog-ref: "https://www.elastic.co/blog/" - curator-ref: "https://www.elastic.co/guide/en/elasticsearch/client/curator/current" - curator-ref-current: "https://www.elastic.co/guide/en/elasticsearch/client/curator/current" - metrics-ref: "https://www.elastic.co/guide/en/metrics/current" - metrics-guide: "https://www.elastic.co/guide/en/metrics/guide/current" - logs-ref: "https://www.elastic.co/guide/en/logs/current" - logs-guide: "https://www.elastic.co/guide/en/logs/guide/current" - uptime-guide: "https://www.elastic.co/guide/en/uptime/current" - observability-guide: "https://www.elastic.co/guide/en/observability/current" - observability-guide-all: "https://www.elastic.co/guide/en/observability" - siem-guide: "https://www.elastic.co/guide/en/siem/guide/current" - security-guide: "https://www.elastic.co/guide/en/security/current" - security-guide-all: "https://www.elastic.co/guide/en/security" - endpoint-guide: "https://www.elastic.co/guide/en/endpoint/current" - sql-odbc: "https://www.elastic.co/guide/en/elasticsearch/sql-odbc/current" - ecs-ref: "https://www.elastic.co/guide/en/ecs/current" - ecs-logging-ref: "https://www.elastic.co/guide/en/ecs-logging/overview/current" - ecs-logging-go-logrus-ref: "https://www.elastic.co/guide/en/ecs-logging/go-logrus/current" - ecs-logging-go-zap-ref: "https://www.elastic.co/guide/en/ecs-logging/go-zap/current" - ecs-logging-go-zerolog-ref: "https://www.elastic.co/guide/en/ecs-logging/go-zap/current" - ecs-logging-java-ref: "https://www.elastic.co/guide/en/ecs-logging/java/current" - ecs-logging-dotnet-ref: "https://www.elastic.co/guide/en/ecs-logging/dotnet/current" - ecs-logging-nodejs-ref: "https://www.elastic.co/guide/en/ecs-logging/nodejs/current" - ecs-logging-php-ref: "https://www.elastic.co/guide/en/ecs-logging/php/current" - ecs-logging-python-ref: "https://www.elastic.co/guide/en/ecs-logging/python/current" - ecs-logging-ruby-ref: "https://www.elastic.co/guide/en/ecs-logging/ruby/current" - ml-docs: "https://www.elastic.co/guide/en/machine-learning/current" - eland-docs: "https://www.elastic.co/guide/en/elasticsearch/client/eland/current" - eql-ref: "https://eql.readthedocs.io/en/latest/query-guide" - extendtrial: "https://www.elastic.co/trialextension" - wikipedia: "https://en.wikipedia.org/wiki" - forum: "https://discuss.elastic.co/" - xpack-forum: "https://discuss.elastic.co/c/50-x-pack" - security-forum: "https://discuss.elastic.co/c/x-pack/shield" - watcher-forum: "https://discuss.elastic.co/c/x-pack/watcher" - monitoring-forum: "https://discuss.elastic.co/c/x-pack/marvel" - graph-forum: "https://discuss.elastic.co/c/x-pack/graph" - apm-forum: "https://discuss.elastic.co/c/apm" - enterprise-search-ref: "https://www.elastic.co/guide/en/enterprise-search/current" - app-search-ref: "https://www.elastic.co/guide/en/app-search/current" - workplace-search-ref: "https://www.elastic.co/guide/en/workplace-search/current" - enterprise-search-node-ref: "https://www.elastic.co/guide/en/enterprise-search-clients/enterprise-search-node/current" - enterprise-search-php-ref: "https://www.elastic.co/guide/en/enterprise-search-clients/php/current" - enterprise-search-python-ref: "https://www.elastic.co/guide/en/enterprise-search-clients/python/current" - enterprise-search-ruby-ref: "https://www.elastic.co/guide/en/enterprise-search-clients/ruby/current" - elastic-maps-service: "https://maps.elastic.co" - integrations-docs: "https://docs.elastic.co/en/integrations" - integrations-devguide: "https://www.elastic.co/guide/en/integrations-developer/current" - time-units: "https://www.elastic.co/guide/en/elasticsearch/reference/current/api-conventions.html#time-units" - byte-units: "https://www.elastic.co/guide/en/elasticsearch/reference/current/api-conventions.html#byte-units" - apm-py-ref-v: "https://www.elastic.co/guide/en/apm/agent/python/current" - apm-node-ref-v: "https://www.elastic.co/guide/en/apm/agent/nodejs/current" - apm-rum-ref-v: "https://www.elastic.co/guide/en/apm/agent/rum-js/current" - apm-ruby-ref-v: "https://www.elastic.co/guide/en/apm/agent/ruby/current" - apm-java-ref-v: "https://www.elastic.co/guide/en/apm/agent/java/current" - apm-go-ref-v: "https://www.elastic.co/guide/en/apm/agent/go/current" - apm-ios-ref-v: "https://www.elastic.co/guide/en/apm/agent/swift/current" - apm-dotnet-ref-v: "https://www.elastic.co/guide/en/apm/agent/dotnet/current" - apm-php-ref-v: "https://www.elastic.co/guide/en/apm/agent/php/current" ecloud: "Elastic Cloud" - esf: "Elastic Serverless Forwarder" - ess: "Elasticsearch Service" - ece: "Elastic Cloud Enterprise" - eck: "Elastic Cloud on Kubernetes" - serverless-full: "Elastic Cloud Serverless" - serverless-short: "Serverless" - es-serverless: "Elasticsearch Serverless" - es3: "Elasticsearch Serverless" - obs-serverless: "Elastic Observability Serverless" - sec-serverless: "Elastic Security Serverless" - serverless-docs: "https://docs.elastic.co/serverless" - cloud: "https://www.elastic.co/guide/en/cloud/current" - ess-utm-params: "?page=docs&placement=docs-body" - ess-baymax: "?page=docs&placement=docs-body" - ess-trial: "https://cloud.elastic.co/registration?page=docs&placement=docs-body" - ess-product: "https://www.elastic.co/cloud/elasticsearch-service?page=docs&placement=docs-body" - ess-console: "https://cloud.elastic.co?page=docs&placement=docs-body" - ess-console-name: "Elasticsearch Service Console" - ess-deployments: "https://cloud.elastic.co/deployments?page=docs&placement=docs-body" - ece-ref: "https://www.elastic.co/guide/en/cloud-enterprise/current" - eck-ref: "https://www.elastic.co/guide/en/cloud-on-k8s/current" - ess-leadin: "You can run Elasticsearch on your own hardware or use our hosted Elasticsearch Service that is available on AWS, GCP, and Azure. https://cloud.elastic.co/registration{ess-utm-params}[Try the Elasticsearch Service for free]." - ess-leadin-short: "Our hosted Elasticsearch Service is available on AWS, GCP, and Azure, and you can https://cloud.elastic.co/registration{ess-utm-params}[try it for free]." - ess-icon: "image:https://doc-icons.s3.us-east-2.amazonaws.com/logo_cloud.svg[link=\"https://cloud.elastic.co/registration{ess-utm-params}\", title=\"Supported on Elasticsearch Service\"]" - ece-icon: "image:https://doc-icons.s3.us-east-2.amazonaws.com/logo_cloud_ece.svg[link=\"https://cloud.elastic.co/registration{ess-utm-params}\", title=\"Supported on Elastic Cloud Enterprise\"]" - cloud-only: "This feature is designed for indirect use by https://cloud.elastic.co/registration{ess-utm-params}[Elasticsearch Service], https://www.elastic.co/guide/en/cloud-enterprise/{ece-version-link}[Elastic Cloud Enterprise], and https://www.elastic.co/guide/en/cloud-on-k8s/current[Elastic Cloud on Kubernetes]. Direct use is not supported." - ess-setting-change: "image:https://doc-icons.s3.us-east-2.amazonaws.com/logo_cloud.svg[link=\"{ess-trial}\", title=\"Supported on {ess}\"] indicates a change to a supported https://www.elastic.co/guide/en/cloud/current/ec-add-user-settings.html[user setting] for Elasticsearch Service." - ess-skip-section: "If you use Elasticsearch Service, skip this section. Elasticsearch Service handles these changes for you." - api-cloud: "https://www.elastic.co/docs/api/doc/cloud" - api-ece: "https://www.elastic.co/docs/api/doc/cloud-enterprise" - api-kibana-serverless: "https://www.elastic.co/docs/api/doc/serverless" - es-feature-flag: "This feature is in development and not yet available for use. This documentation is provided for informational purposes only." - es-ref-dir: "'{{elasticsearch-root}}/docs/reference'" - apm-app: "APM app" - uptime-app: "Uptime app" - synthetics-app: "Synthetics app" - logs-app: "Logs app" - metrics-app: "Metrics app" - infrastructure-app: "Infrastructure app" - siem-app: "SIEM app" - security-app: "Elastic Security app" - ml-app: "Machine Learning" - dev-tools-app: "Dev Tools" - ingest-manager-app: "Ingest Manager" - stack-manage-app: "Stack Management" - stack-monitor-app: "Stack Monitoring" - alerts-ui: "Alerts and Actions" - rules-ui: "Rules" - rac-ui: "Rules and Connectors" - connectors-ui: "Connectors" - connectors-feature: "Actions and Connectors" - stack-rules-feature: "Stack Rules" - user-experience: "User Experience" - ems: "Elastic Maps Service" - ems-init: "EMS" - hosted-ems: "Elastic Maps Server" - ipm-app: "Index Pattern Management" - ingest-pipelines: "ingest pipelines" - ingest-pipelines-app: "Ingest Pipelines" - ingest-pipelines-cap: "Ingest pipelines" - ls-pipelines: "Logstash pipelines" - ls-pipelines-app: "Logstash Pipelines" - maint-windows: "maintenance windows" - maint-windows-app: "Maintenance Windows" - maint-windows-cap: "Maintenance windows" - custom-roles-app: "Custom Roles" - data-source: "data view" - data-sources: "data views" - data-source-caps: "Data View" - data-sources-caps: "Data Views" - data-source-cap: "Data view" - data-sources-cap: "Data views" - project-settings: "Project settings" - manage-app: "Management" - index-manage-app: "Index Management" - data-views-app: "Data Views" - rules-app: "Rules" - saved-objects-app: "Saved Objects" - tags-app: "Tags" - api-keys-app: "API keys" - transforms-app: "Transforms" - connectors-app: "Connectors" - files-app: "Files" - reports-app: "Reports" - maps-app: "Maps" - alerts-app: "Alerts" - crawler: "Enterprise Search web crawler" - ents: "Enterprise Search" - app-search-crawler: "App Search web crawler" - agent: "Elastic Agent" - agents: "Elastic Agents" - fleet: "Fleet" - fleet-server: "Fleet Server" - integrations-server: "Integrations Server" - ingest-manager: "Ingest Manager" - ingest-management: "ingest management" - package-manager: "Elastic Package Manager" - integrations: "Integrations" - package-registry: "Elastic Package Registry" - artifact-registry: "Elastic Artifact Registry" - aws: "AWS" - stack: "Elastic Stack" - xpack: "X-Pack" - es: "Elasticsearch" kib: "Kibana" - esms: "Elastic Stack Monitoring Service" - esms-init: "ESMS" - ls: "Logstash" - beats: "Beats" - auditbeat: "Auditbeat" - filebeat: "Filebeat" - heartbeat: "Heartbeat" - metricbeat: "Metricbeat" - packetbeat: "Packetbeat" - winlogbeat: "Winlogbeat" - functionbeat: "Functionbeat" - journalbeat: "Journalbeat" - es-sql: "Elasticsearch SQL" - esql: "ES|QL" - elastic-agent: "Elastic Agent" - k8s: "Kubernetes" - log-driver-long: "Elastic Logging Plugin for Docker" - security: "X-Pack security" - security-features: "security features" - operator-feature: "operator privileges feature" - es-security-features: "Elasticsearch security features" - stack-security-features: "Elastic Stack security features" - endpoint-sec: "Endpoint Security" - endpoint-cloud-sec: "Endpoint and Cloud Security" - elastic-defend: "Elastic Defend" - elastic-sec: "Elastic Security" - elastic-endpoint: "Elastic Endpoint" - swimlane: "Swimlane" - sn: "ServiceNow" - sn-itsm: "ServiceNow ITSM" - sn-itom: "ServiceNow ITOM" - sn-sir: "ServiceNow SecOps" - jira: "Jira" - ibm-r: "IBM Resilient" - webhook: "Webhook" - webhook-cm: "Webhook - Case Management" - opsgenie: "Opsgenie" - bedrock: "Amazon Bedrock" - gemini: "Google Gemini" - hive: "TheHive" - monitoring: "X-Pack monitoring" - monitor-features: "monitoring features" - stack-monitor-features: "Elastic Stack monitoring features" - watcher: "Watcher" - alert-features: "alerting features" - reporting: "X-Pack reporting" - report-features: "reporting features" - graph: "X-Pack graph" - graph-features: "graph analytics features" - searchprofiler: "Search Profiler" - xpackml: "X-Pack machine learning" - ml: "machine learning" - ml-cap: "Machine learning" - ml-init: "ML" - ml-features: "machine learning features" - stack-ml-features: "Elastic Stack machine learning features" - ccr: "cross-cluster replication" - ccr-cap: "Cross-cluster replication" - ccr-init: "CCR" - ccs: "cross-cluster search" - ccs-cap: "Cross-cluster search" - ccs-init: "CCS" - ilm: "index lifecycle management" - ilm-cap: "Index lifecycle management" - ilm-init: "ILM" - dlm: "data lifecycle management" - dlm-cap: "Data lifecycle management" - dlm-init: "DLM" - search-snap: "searchable snapshot" - search-snaps: "searchable snapshots" - search-snaps-cap: "Searchable snapshots" - slm: "snapshot lifecycle management" - slm-cap: "Snapshot lifecycle management" - slm-init: "SLM" - rollup-features: "data rollup features" - ipm: "index pattern management" - ipm-cap: "Index pattern" - rollup: "rollup" - rollup-cap: "Rollup" - rollups: "rollups" - rollups-cap: "Rollups" - rollup-job: "rollup job" - rollup-jobs: "rollup jobs" - rollup-jobs-cap: "Rollup jobs" - dfeed: "datafeed" - dfeeds: "datafeeds" - dfeed-cap: "Datafeed" - dfeeds-cap: "Datafeeds" - ml-jobs: "machine learning jobs" - ml-jobs-cap: "Machine learning jobs" - anomaly-detect: "anomaly detection" - anomaly-detect-cap: "Anomaly detection" - anomaly-job: "anomaly detection job" - anomaly-jobs: "anomaly detection jobs" - anomaly-jobs-cap: "Anomaly detection jobs" - dataframe: "data frame" - dataframes: "data frames" - dataframe-cap: "Data frame" - dataframes-cap: "Data frames" - watcher-transform: "payload transform" - watcher-transforms: "payload transforms" - watcher-transform-cap: "Payload transform" - watcher-transforms-cap: "Payload transforms" - transform: "transform" - transforms: "transforms" - transform-cap: "Transform" - transforms-cap: "Transforms" - dataframe-transform: "transform" - dataframe-transform-cap: "Transform" - dataframe-transforms: "transforms" - dataframe-transforms-cap: "Transforms" - dfanalytics-cap: "Data frame analytics" - dfanalytics: "data frame analytics" - dataframe-analytics-config: "'{dataframe} analytics config'" - dfanalytics-job: "'{dataframe} analytics job'" - dfanalytics-jobs: "'{dataframe} analytics jobs'" - dfanalytics-jobs-cap: "'{dataframe-cap} analytics jobs'" - cdataframe: "continuous data frame" - cdataframes: "continuous data frames" - cdataframe-cap: "Continuous data frame" - cdataframes-cap: "Continuous data frames" - cdataframe-transform: "continuous transform" - cdataframe-transforms: "continuous transforms" - cdataframe-transforms-cap: "Continuous transforms" - ctransform: "continuous transform" - ctransform-cap: "Continuous transform" - ctransforms: "continuous transforms" - ctransforms-cap: "Continuous transforms" - oldetection: "outlier detection" - oldetection-cap: "Outlier detection" - olscore: "outlier score" - olscores: "outlier scores" - fiscore: "feature influence score" - evaluatedf-api: "evaluate {dataframe} analytics API" - evaluatedf-api-cap: "Evaluate {dataframe} analytics API" - binarysc: "binary soft classification" - binarysc-cap: "Binary soft classification" - regression: "regression" - regression-cap: "Regression" - reganalysis: "regression analysis" - reganalysis-cap: "Regression analysis" - depvar: "dependent variable" - feature-var: "feature variable" - feature-vars: "feature variables" - feature-vars-cap: "Feature variables" - classification: "classification" - classification-cap: "Classification" - classanalysis: "classification analysis" - classanalysis-cap: "Classification analysis" - infer-cap: "Inference" - infer: "inference" - lang-ident-cap: "Language identification" - lang-ident: "language identification" - data-viz: "Data Visualizer" - file-data-viz: "File Data Visualizer" - feat-imp: "feature importance" - feat-imp-cap: "Feature importance" - nlp: "natural language processing" - nlp-cap: "Natural language processing" - apm-agent: "APM agent" - apm-go-agent: "Elastic APM Go agent" - apm-go-agents: "Elastic APM Go agents" - apm-ios-agent: "Elastic APM iOS agent" - apm-ios-agents: "Elastic APM iOS agents" - apm-java-agent: "Elastic APM Java agent" - apm-java-agents: "Elastic APM Java agents" - apm-dotnet-agent: "Elastic APM .NET agent" - apm-dotnet-agents: "Elastic APM .NET agents" - apm-node-agent: "Elastic APM Node.js agent" - apm-node-agents: "Elastic APM Node.js agents" - apm-php-agent: "Elastic APM PHP agent" - apm-php-agents: "Elastic APM PHP agents" - apm-py-agent: "Elastic APM Python agent" - apm-py-agents: "Elastic APM Python agents" - apm-ruby-agent: "Elastic APM Ruby agent" - apm-ruby-agents: "Elastic APM Ruby agents" - apm-rum-agent: "Elastic APM Real User Monitoring (RUM) JavaScript agent" - apm-rum-agents: "Elastic APM RUM JavaScript agents" apm-lambda-ext: "Elastic APM AWS Lambda extension" - project-monitors: "project monitors" - project-monitors-cap: "Project monitors" - private-location: "Private Location" - private-locations: "Private Locations" - pwd: "YOUR_PASSWORD" - esh: "ES-Hadoop" - default-dist: "default distribution" - oss-dist: "OSS-only distribution" - observability: "Observability" - api-request-title: "Request" - api-prereq-title: "Prerequisites" - api-description-title: "Description" - api-path-parms-title: "Path parameters" - api-query-parms-title: "Query parameters" - api-request-body-title: "Request body" - api-response-codes-title: "Response codes" - api-response-body-title: "Response body" - api-example-title: "Example" - api-examples-title: "Examples" - api-definitions-title: "Properties" - multi-arg: "†footnoteref:[multi-arg,This parameter accepts multiple arguments.]" - multi-arg-ref: "†footnoteref:[multi-arg]" - yes-icon: "image:https://doc-icons.s3.us-east-2.amazonaws.com/icon-yes.png[Yes,20,15]" - no-icon: "image:https://doc-icons.s3.us-east-2.amazonaws.com/icon-no.png[No,20,15]" - es-repo: "https://github.com/elastic/elasticsearch/" - es-issue: "https://github.com/elastic/elasticsearch/issues/" - es-pull: "https://github.com/elastic/elasticsearch/pull/" - es-commit: "https://github.com/elastic/elasticsearch/commit/" - kib-repo: "https://github.com/elastic/kibana/" - kib-issue: "https://github.com/elastic/kibana/issues/" - kibana-issue: "'{kib-repo}issues/'" - kib-pull: "https://github.com/elastic/kibana/pull/" - kibana-pull: "'{kib-repo}pull/'" - kib-commit: "https://github.com/elastic/kibana/commit/" - ml-repo: "https://github.com/elastic/ml-cpp/" - ml-issue: "https://github.com/elastic/ml-cpp/issues/" - ml-pull: "https://github.com/elastic/ml-cpp/pull/" - ml-commit: "https://github.com/elastic/ml-cpp/commit/" - apm-repo: "https://github.com/elastic/apm-server/" - apm-issue: "https://github.com/elastic/apm-server/issues/" - apm-pull: "https://github.com/elastic/apm-server/pull/" - kibana-blob: "https://github.com/elastic/kibana/blob/current/" - apm-get-started-ref: "https://www.elastic.co/guide/en/apm/get-started/current" - apm-server-ref: "https://www.elastic.co/guide/en/apm/server/current" - apm-server-ref-v: "https://www.elastic.co/guide/en/apm/server/current" - apm-server-ref-m: "https://www.elastic.co/guide/en/apm/server/master" - apm-server-ref-62: "https://www.elastic.co/guide/en/apm/server/6.2" - apm-server-ref-64: "https://www.elastic.co/guide/en/apm/server/6.4" - apm-server-ref-70: "https://www.elastic.co/guide/en/apm/server/7.0" - apm-overview-ref-v: "https://www.elastic.co/guide/en/apm/get-started/current" - apm-overview-ref-70: "https://www.elastic.co/guide/en/apm/get-started/7.0" - apm-overview-ref-m: "https://www.elastic.co/guide/en/apm/get-started/master" - infra-guide: "https://www.elastic.co/guide/en/infrastructure/guide/current" - a-data-source: "a data view" - icon-bug: "pass:[]" - icon-checkInCircleFilled: "pass:[]" - icon-warningFilled: "pass:[]" From 21530349eafb1528022d18228580ab4261e8a006 Mon Sep 17 00:00:00 2001 From: Colleen McGinnis Date: Wed, 19 Mar 2025 19:38:58 -0500 Subject: [PATCH 2/6] move images --- docs/reference/aws-lambda.md | 4 ++-- docs/reference/configuration.md | 2 +- docs/reference/how-to-find-slow-methods.md | 2 +- docs/{ => reference}/images/config-layer.png | Bin docs/{ => reference}/images/dynamic-config.svg | 0 docs/{ => reference}/images/green-check.svg | 0 .../{ => reference}/images/java-lambda-env-vars.png | Bin docs/{ => reference}/images/red-x.svg | 0 8 files changed, 4 insertions(+), 4 deletions(-) rename docs/{ => reference}/images/config-layer.png (100%) rename docs/{ => reference}/images/dynamic-config.svg (100%) rename docs/{ => reference}/images/green-check.svg (100%) rename docs/{ => reference}/images/java-lambda-env-vars.png (100%) rename docs/{ => reference}/images/red-x.svg (100%) diff --git a/docs/reference/aws-lambda.md b/docs/reference/aws-lambda.md index 929806cc18..c1b0642a80 100644 --- a/docs/reference/aws-lambda.md +++ b/docs/reference/aws-lambda.md @@ -42,7 +42,7 @@ Both the [{{apm-lambda-ext}}](apm-aws-lambda://reference/index.md) and the Java To add the layers to your Lambda function through the AWS Management Console: 1. Navigate to your function in the AWS Management Console -2. Scroll to the Layers section and click the *Add a layer* button ![image of layer configuration section in AWS Console](../images/config-layer.png "") +2. Scroll to the Layers section and click the *Add a layer* button ![image of layer configuration section in AWS Console](images/config-layer.png "") 3. Choose the *Specify an ARN* radio button 4. Copy and paste the following ARNs of the {{apm-lambda-ext}} layer and the APM agent layer in the *Specify an ARN* text input: * APM Extension layer: @@ -169,7 +169,7 @@ ELASTIC_APM_SEND_STRATEGY = background <4> 3. This is your APM secret token. 4. The [ELASTIC_APM_SEND_STRATEGY](apm-aws-lambda://reference/aws-lambda-config-options.md#_elastic_apm_send_strategy) defines when APM data is sent to your Elastic APM backend. To reduce the execution time of your lambda functions, we recommend to use the background strategy in production environments with steady load scenarios. -![Java environment variables configuration section in AWS Console](../images/java-lambda-env-vars.png "") +![Java environment variables configuration section in AWS Console](images/java-lambda-env-vars.png "") :::::: ::::::{tab-item} AWS CLI diff --git a/docs/reference/configuration.md b/docs/reference/configuration.md index 6051b85c98..7575057607 100644 --- a/docs/reference/configuration.md +++ b/docs/reference/configuration.md @@ -8,7 +8,7 @@ mapped_pages: To adapt the Elastic APM Java agent to your needs, you can configure it using one of the methods below, listed in descending order of precedence: 1) [Central configuration](docs-content://solutions/observability/apps/apm-agent-central-configuration.md) -: Configure the Agent in the Kibana APM app. [![dynamic config](../images/dynamic-config.svg "") ](#configuration-dynamic) +: Configure the Agent in the Kibana APM app. [![dynamic config](images/dynamic-config.svg "") ](#configuration-dynamic) 2) Properties file : The `elasticapm.properties` file is located in the same folder as the agent jar, or provided through the [`config_file`](/reference/config-core.md#config-config-file) option. ![dynamic config](../images/dynamic-config.svg "") diff --git a/docs/reference/how-to-find-slow-methods.md b/docs/reference/how-to-find-slow-methods.md index d1a9c9b0c3..9848a5c24f 100644 --- a/docs/reference/how-to-find-slow-methods.md +++ b/docs/reference/how-to-find-slow-methods.md @@ -15,7 +15,7 @@ Identifying a problematic service is only half of the battle when diagnosing app Find out which part of your code is making your application slow by periodically recording running methods with a sampling-based profiler. -![green check](../images/green-check.svg "") Very low overhead.
![green check](../images/green-check.svg "") No code changes required.
![red x](../images/red-x.svg "") Does not work on Windows and on OpenJ9.
![red x](../images/red-x.svg "") The duration of profiler-inferred spans are not exact measurements, only estimates. +![green check](images/green-check.svg "") Very low overhead.
![green check](../images/green-check.svg "") No code changes required.
![red x](images/red-x.svg "") Does not work on Windows and on OpenJ9.
![red x](../images/red-x.svg "") The duration of profiler-inferred spans are not exact measurements, only estimates. [Learn more](/reference/method-sampling-based.md) diff --git a/docs/images/config-layer.png b/docs/reference/images/config-layer.png similarity index 100% rename from docs/images/config-layer.png rename to docs/reference/images/config-layer.png diff --git a/docs/images/dynamic-config.svg b/docs/reference/images/dynamic-config.svg similarity index 100% rename from docs/images/dynamic-config.svg rename to docs/reference/images/dynamic-config.svg diff --git a/docs/images/green-check.svg b/docs/reference/images/green-check.svg similarity index 100% rename from docs/images/green-check.svg rename to docs/reference/images/green-check.svg diff --git a/docs/images/java-lambda-env-vars.png b/docs/reference/images/java-lambda-env-vars.png similarity index 100% rename from docs/images/java-lambda-env-vars.png rename to docs/reference/images/java-lambda-env-vars.png diff --git a/docs/images/red-x.svg b/docs/reference/images/red-x.svg similarity index 100% rename from docs/images/red-x.svg rename to docs/reference/images/red-x.svg From d3809d84a0fba133f04a2c95f9afe00de742a238 Mon Sep 17 00:00:00 2001 From: Colleen McGinnis Date: Wed, 19 Mar 2025 20:03:30 -0500 Subject: [PATCH 3/6] update redirected links --- docs/reference/metrics.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/reference/metrics.md b/docs/reference/metrics.md index 680788c55e..1ed6cf02f0 100644 --- a/docs/reference/metrics.md +++ b/docs/reference/metrics.md @@ -31,7 +31,7 @@ Dedicated JVM metrics views are available since Elastic stack version 7.2. Start Host metrics. As of version 6.6, these metrics will be visualized in the APM app. -For more system metrics, consider installing [metricbeat](beats://reference/metricbeat/metricbeat.md) on your hosts. +For more system metrics, consider installing [metricbeat](beats://reference/metricbeat/index.md) on your hosts. **`system.cpu.total.norm.pct`** : type: scaled_float From 17143ecb0d3e23ec6fb81529a72144d5964ec8c2 Mon Sep 17 00:00:00 2001 From: Colleen McGinnis Date: Thu, 20 Mar 2025 18:23:49 -0500 Subject: [PATCH 4/6] fix image paths --- .../test/resources/configuration.asciidoc.ftl | 10 ++--- docs/reference/config-circuit-breaker.md | 12 +++--- docs/reference/config-core.md | 42 +++++++++---------- docs/reference/config-datastore.md | 4 +- docs/reference/config-http.md | 12 +++--- docs/reference/config-huge-traces.md | 8 ++-- docs/reference/config-jmx.md | 2 +- docs/reference/config-logging.md | 6 +-- docs/reference/config-messaging.md | 4 +- docs/reference/config-metrics.md | 2 +- docs/reference/config-profiling.md | 12 +++--- docs/reference/config-reporter.md | 14 +++---- docs/reference/config-stacktrace.md | 6 +-- docs/reference/configuration.md | 8 ++-- 14 files changed, 71 insertions(+), 71 deletions(-) diff --git a/apm-agent-builds/apm-agent/src/test/resources/configuration.asciidoc.ftl b/apm-agent-builds/apm-agent/src/test/resources/configuration.asciidoc.ftl index bfdb62c1f0..3d1ab540cc 100644 --- a/apm-agent-builds/apm-agent/src/test/resources/configuration.asciidoc.ftl +++ b/apm-agent-builds/apm-agent/src/test/resources/configuration.asciidoc.ftl @@ -9,16 +9,16 @@ you can configure it using one of the methods below, listed in descending order [horizontal] 1) {apm-app-ref}/agent-configuration.html[Central configuration]:: Configure the Agent in the Kibana APM app. -<> +<> 2) Properties file:: The `elasticapm.properties` file is located in the same folder as the agent jar, or provided through the <> option. -image:./images/dynamic-config.svg[link=configuration.html#configuration-dynamic] +image:/reference/images/dynamic-config.svg[link=configuration.html#configuration-dynamic] 3) Java system properties:: All configuration keys are prefixed with `elastic.apm.` + -image:./images/dynamic-config.svg[link=configuration.html#configuration-dynamic] +image:/reference/images/dynamic-config.svg[link=configuration.html#configuration-dynamic] 4) Environment variables:: All configuration keys are in uppercase and prefixed with `ELASTIC_APM_`. @@ -36,7 +36,7 @@ Defined for each configuration. [float] [[configuration-dynamic]] -=== Dynamic configuration image:./images/dynamic-config.svg[] +=== Dynamic configuration image:/reference/images/dynamic-config.svg[] Configuration options marked with Dynamic true can be changed at runtime when set from supported sources: @@ -119,7 +119,7 @@ NOTE: This feature is currently experimental, which means it is disabled by defa ${option.description} -<#if option.dynamic><> +<#if option.dynamic><> <#if option.valueType?matches("TimeDuration")> <#if option.valueConverter.canUseMicros> diff --git a/docs/reference/config-circuit-breaker.md b/docs/reference/config-circuit-breaker.md index 1780ae7cec..e01f04c913 100644 --- a/docs/reference/config-circuit-breaker.md +++ b/docs/reference/config-circuit-breaker.md @@ -12,7 +12,7 @@ mapped_pages: A boolean specifying whether the circuit breaker should be enabled or not. When enabled, the agent periodically polls stress monitors to detect system/process/JVM stress state. If ANY of the monitors detects a stress indication, the agent will become inactive, as if the [`recording`](/reference/config-core.md#config-recording) configuration option has been set to `false`, thus reducing resource consumption to a minimum. When inactive, the agent continues polling the same monitors in order to detect whether the stress state has been relieved. If ALL monitors approve that the system/process/JVM is not under stress anymore, the agent will resume and become fully functional. -[![dynamic config](../images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic) +[![dynamic config](/reference/images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic) | Default | Type | Dynamic | | --- | --- | --- | @@ -42,7 +42,7 @@ Supports the duration suffixes `ms`, `s` and `m`. Example: `5s`. The threshold used by the GC monitor to rely on for identifying heap stress. The same threshold will be used for all heap pools, so that if ANY has a usage percentage that crosses it, the agent will consider it as a heap stress. The GC monitor relies only on memory consumption measured after a recent GC. -[![dynamic config](../images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic) +[![dynamic config](/reference/images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic) | Default | Type | Dynamic | | --- | --- | --- | @@ -57,7 +57,7 @@ The threshold used by the GC monitor to rely on for identifying heap stress. The The threshold used by the GC monitor to rely on for identifying when the heap is not under stress . If `stress_monitor_gc_stress_threshold` has been crossed, the agent will consider it a heap-stress state. In order to determine that the stress state is over, percentage of occupied memory in ALL heap pools should be lower than this threshold. The GC monitor relies only on memory consumption measured after a recent GC. -[![dynamic config](../images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic) +[![dynamic config](/reference/images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic) | Default | Type | Dynamic | | --- | --- | --- | @@ -72,7 +72,7 @@ The threshold used by the GC monitor to rely on for identifying when the heap is The minimal time required in order to determine whether the system is either currently under stress, or that the stress detected previously has been relieved. All measurements during this time must be consistent in comparison to the relevant threshold in order to detect a change of stress state. Must be at least `1m`. -[![dynamic config](../images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic) +[![dynamic config](/reference/images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic) Supports the duration suffixes `ms`, `s` and `m`. Example: `1m`. @@ -89,7 +89,7 @@ Supports the duration suffixes `ms`, `s` and `m`. Example: `1m`. The threshold used by the system CPU monitor to detect system CPU stress. If the system CPU crosses this threshold for a duration of at least `stress_monitor_cpu_duration_threshold`, the monitor considers this as a stress state. -[![dynamic config](../images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic) +[![dynamic config](/reference/images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic) | Default | Type | Dynamic | | --- | --- | --- | @@ -104,7 +104,7 @@ The threshold used by the system CPU monitor to detect system CPU stress. If the The threshold used by the system CPU monitor to determine that the system is not under CPU stress. If the monitor detected a CPU stress, the measured system CPU needs to be below this threshold for a duration of at least `stress_monitor_cpu_duration_threshold` in order for the monitor to decide that the CPU stress has been relieved. -[![dynamic config](../images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic) +[![dynamic config](/reference/images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic) | Default | Type | Dynamic | | --- | --- | --- | diff --git a/docs/reference/config-core.md b/docs/reference/config-core.md index f782595791..1ea6c90949 100644 --- a/docs/reference/config-core.md +++ b/docs/reference/config-core.md @@ -19,7 +19,7 @@ A boolean specifying if the agent should be recording or not. When recording, th You can use this setting to dynamically disable Elastic APM at runtime. -[![dynamic config](../images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic) +[![dynamic config](/reference/images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic) | Default | Type | Dynamic | | --- | --- | --- | @@ -57,7 +57,7 @@ Changing this value at runtime can slow down the application temporarily. :::: -[![dynamic config](../images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic) +[![dynamic config](/reference/images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic) | Default | Type | Dynamic | | --- | --- | --- | @@ -212,7 +212,7 @@ By default, the agent will sample every transaction (e.g. request to your servic Value will be rounded with 4 significant digits, as an example, value *0.55555* will be rounded to `0.5556` -[![dynamic config](../images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic) +[![dynamic config](/reference/images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic) | Default | Type | Dynamic | | --- | --- | --- | @@ -233,7 +233,7 @@ Setting an upper limit will prevent overloading the agent and the APM server wit A message will be logged when the max number of spans has been exceeded but only at a rate of once every 5 minutes to ensure performance is not impacted. -[![dynamic config](../images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic) +[![dynamic config](/reference/images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic) | Default | Type | Dynamic | | --- | --- | --- | @@ -281,7 +281,7 @@ Review the data captured by Elastic APM carefully to make sure it does not captu :::: -[![dynamic config](../images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic) +[![dynamic config](/reference/images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic) | Default | Type | Dynamic | | --- | --- | --- | @@ -301,7 +301,7 @@ Changing this value at runtime can slow down the application temporarily. :::: -[![dynamic config](../images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic) +[![dynamic config](/reference/images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic) | Default | Type | Dynamic | | --- | --- | --- | @@ -321,7 +321,7 @@ Changing this value at runtime can slow down the application temporarily. :::: -[![dynamic config](../images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic) +[![dynamic config](/reference/images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic) | Default | Type | Dynamic | | --- | --- | --- | @@ -341,7 +341,7 @@ Changing this value at runtime can slow down the application temporarily. Settin :::: -[![dynamic config](../images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic) +[![dynamic config](/reference/images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic) | Default | Type | Dynamic | | --- | --- | --- | @@ -358,7 +358,7 @@ When reporting exceptions, un-nests the exceptions matching the wildcard pattern This option supports the wildcard `*`, which matches zero or more characters. Examples: `/foo/*/bar/*/baz*`, `*foo*`. Matching is case insensitive by default. Prepending an element with `(?-i)` makes the matching case sensitive. -[![dynamic config](../images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic) +[![dynamic config](/reference/images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic) | Default | Type | Dynamic | | --- | --- | --- | @@ -386,7 +386,7 @@ Exception inheritance is not supported, thus you have to explicitly list all the :::: -[![dynamic config](../images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic) +[![dynamic config](/reference/images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic) | Default | Type | Dynamic | | --- | --- | --- | @@ -420,7 +420,7 @@ Request bodies often contain sensitive values like passwords, credit card number :::: -[![dynamic config](../images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic) +[![dynamic config](/reference/images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic) Valid options: `off`, `errors`, `transactions`, `all` @@ -442,7 +442,7 @@ Setting this to `false` reduces network bandwidth, disk space and object allocat :::: -[![dynamic config](../images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic) +[![dynamic config](/reference/images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic) | Default | Type | Dynamic | | --- | --- | --- | @@ -488,7 +488,7 @@ A boolean specifying if the agent should instrument pre-Java-1.4 bytecode. When set to true, disables log sending, metrics and trace collection. Trace context propagation and log correlation will stay active. Note that in contrast to [`disable_send`](/reference/config-reporter.md#config-disable-send) the agent will still connect to the APM-server for fetching configuration updates and health checks. -[![dynamic config](../images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic) +[![dynamic config](/reference/images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic) | Default | Type | Dynamic | | --- | --- | --- | @@ -576,7 +576,7 @@ Changing this value at runtime can slow down the application temporarily. :::: -[![dynamic config](../images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic) +[![dynamic config](/reference/images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic) | Default | Type | Dynamic | | --- | --- | --- | @@ -623,7 +623,7 @@ Supports the duration suffixes `ms`, `s` and `m`. Example: `0ms`. When enabled, the agent will make periodic requests to the APM Server to fetch updated configuration. The frequency of the periodic request is driven by the `Cache-Control` header returned from APM Server/Integration, falling back to 5 minutes if not defined. -[![dynamic config](../images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic) +[![dynamic config](/reference/images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic) | Default | Type | Dynamic | | --- | --- | --- | @@ -691,7 +691,7 @@ To enable [distributed tracing](docs-content://solutions/observability/apps/trac When this setting is `true`, the agent will also add the header `elastic-apm-traceparent` for backwards compatibility with older versions of Elastic APM agents. -[![dynamic config](../images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic) +[![dynamic config](/reference/images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic) | Default | Type | Dynamic | | --- | --- | --- | @@ -711,7 +711,7 @@ Disabling `tracecontext` headers injection means that [distributed tracing](docs :::: -[![dynamic config](../images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic) +[![dynamic config](/reference/images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic) | Default | Type | Dynamic | | --- | --- | --- | @@ -730,7 +730,7 @@ The attempt fails if they lead up to a span that can’t be discarded. Spans tha However, external calls that don’t propagate context, such as calls to a database, can be discarded using this threshold. -[![dynamic config](../images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic) +[![dynamic config](/reference/images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic) Supports the duration suffixes `ms`, `s` and `m`. Example: `0ms`. @@ -777,7 +777,7 @@ With this option, you can group transaction names that contain dynamic parts wit This option supports the wildcard `*`, which matches zero or more characters. Examples: `/foo/*/bar/*/baz*`, `*foo*`. Matching is case insensitive by default. Prepending an element with `(?-i)` makes the matching case sensitive. -[![dynamic config](../images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic) +[![dynamic config](/reference/images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic) | Default | Type | Dynamic | | --- | --- | --- | @@ -805,7 +805,7 @@ Starting with Elastic Observability 8.2, span links are visible in trace views. This option is case-insensitive. -[![dynamic config](../images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic) +[![dynamic config](/reference/images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic) Valid options: `continue`, `restart`, `restart_external` @@ -822,7 +822,7 @@ Valid options: `continue`, `restart`, `restart_external` If any baggage key matches any of the patterns provided via this config option, the corresponding baggage key and value will be automatically stored on the corresponding transactions, spans and errors. The baggage keys will be prefixed with "baggage." on storage. -[![dynamic config](../images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic) +[![dynamic config](/reference/images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic) | Default | Type | Dynamic | | --- | --- | --- | diff --git a/docs/reference/config-datastore.md b/docs/reference/config-datastore.md index 01dfbf0c7a..a5c98a6f31 100644 --- a/docs/reference/config-datastore.md +++ b/docs/reference/config-datastore.md @@ -14,7 +14,7 @@ The URL path patterns for which the APM agent will capture the request body of o The captured request body (if any) is stored on the `span.db.statement` field. Captured request bodies are truncated to a maximum length defined by [`long_field_max_length` (performance [1.37.0])](/reference/config-core.md#config-long-field-max-length). This option supports the wildcard `*`, which matches zero or more characters. Examples: `/foo/*/bar/*/baz*`, `*foo*`. Matching is case insensitive by default. Prepending an element with `(?-i)` makes the matching case sensitive. -[![dynamic config](../images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic) +[![dynamic config](/reference/images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic) | Default | Type | Dynamic | | --- | --- | --- | @@ -31,7 +31,7 @@ MongoDB command names for which the command document will be captured, limited t This option supports the wildcard `*`, which matches zero or more characters. Examples: `/foo/*/bar/*/baz*`, `*foo*`. Matching is case insensitive by default. Prepending an element with `(?-i)` makes the matching case sensitive. -[![dynamic config](../images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic) +[![dynamic config](/reference/images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic) | Default | Type | Dynamic | | --- | --- | --- | diff --git a/docs/reference/config-http.md b/docs/reference/config-http.md index 9662ca3921..3a6aa3c28f 100644 --- a/docs/reference/config-http.md +++ b/docs/reference/config-http.md @@ -16,7 +16,7 @@ The defaults end with a wildcard so that content types like `text/plain; charset This option supports the wildcard `*`, which matches zero or more characters. Examples: `/foo/*/bar/*/baz*`, `*foo*`. Matching is case insensitive by default. Prepending an element with `(?-i)` makes the matching case sensitive. -[![dynamic config](../images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic) +[![dynamic config](/reference/images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic) | Default | Type | Dynamic | | --- | --- | --- | @@ -35,7 +35,7 @@ This property should be set to an array containing one or more strings. When an This option supports the wildcard `*`, which matches zero or more characters. Examples: `/foo/*/bar/*/baz*`, `*foo*`. Matching is case insensitive by default. Prepending an element with `(?-i)` makes the matching case sensitive. -[![dynamic config](../images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic) +[![dynamic config](/reference/images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic) | Default | Type | Dynamic | | --- | --- | --- | @@ -54,7 +54,7 @@ When an incoming HTTP request is detected, the User-Agent from the request heade This option supports the wildcard `*`, which matches zero or more characters. Examples: `/foo/*/bar/*/baz*`, `*foo*`. Matching is case insensitive by default. Prepending an element with `(?-i)` makes the matching case sensitive. -[![dynamic config](../images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic) +[![dynamic config](/reference/images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic) | Default | Type | Dynamic | | --- | --- | --- | @@ -74,7 +74,7 @@ If your URLs contain path parameters like `/user/$userId`, you should be very ca :::: -[![dynamic config](../images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic) +[![dynamic config](/reference/images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic) | Default | Type | Dynamic | | --- | --- | --- | @@ -95,7 +95,7 @@ With this option, you can group several URL paths together by using a wildcard e This option supports the wildcard `*`, which matches zero or more characters. Examples: `/foo/*/bar/*/baz*`, `*foo*`. Matching is case insensitive by default. Prepending an element with `(?-i)` makes the matching case sensitive. -[![dynamic config](../images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic) +[![dynamic config](/reference/images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic) | Default | Type | Dynamic | | --- | --- | --- | @@ -119,7 +119,7 @@ Currently only support for Apache Http Client v4 and v5, HttpUrlConnection, Spri The body will be stored in the `labels.http_request_body_content` field on the span documents. -[![dynamic config](../images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic) +[![dynamic config](/reference/images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic) | Default | Type | Dynamic | | --- | --- | --- | diff --git a/docs/reference/config-huge-traces.md b/docs/reference/config-huge-traces.md index c6454c35e8..407f08f835 100644 --- a/docs/reference/config-huge-traces.md +++ b/docs/reference/config-huge-traces.md @@ -12,7 +12,7 @@ mapped_pages: Setting this option to true will enable span compression feature. Span compression reduces the collection, processing, and storage overhead, and removes clutter from the UI. The tradeoff is that some information such as DB statements of all the compressed spans will not be collected. -[![dynamic config](../images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic) +[![dynamic config](/reference/images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic) | Default | Type | Dynamic | | --- | --- | --- | @@ -27,7 +27,7 @@ Setting this option to true will enable span compression feature. Span compressi Consecutive spans that are exact match and that are under this threshold will be compressed into a single composite span. This option does not apply to composite spans. This reduces the collection, processing, and storage overhead, and removes clutter from the UI. The tradeoff is that the DB statements of all the compressed spans will not be collected. -[![dynamic config](../images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic) +[![dynamic config](/reference/images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic) Supports the duration suffixes `ms`, `s` and `m`. Example: `50ms`. @@ -44,7 +44,7 @@ Supports the duration suffixes `ms`, `s` and `m`. Example: `50ms`. Consecutive spans to the same destination that are under this threshold will be compressed into a single composite span. This option does not apply to composite spans. This reduces the collection, processing, and storage overhead, and removes clutter from the UI. The tradeoff is that the DB statements of all the compressed spans will not be collected. -[![dynamic config](../images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic) +[![dynamic config](/reference/images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic) Supports the duration suffixes `ms`, `s` and `m`. Example: `0ms`. @@ -66,7 +66,7 @@ If a span propagates distributed tracing ids, it will not be ignored, even if it :::: -[![dynamic config](../images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic) +[![dynamic config](/reference/images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic) Supports the duration suffixes `us`, `ms`, `s` and `m`. Example: `0ms`. diff --git a/docs/reference/config-jmx.md b/docs/reference/config-jmx.md index 7838b6daad..cc0f321a84 100644 --- a/docs/reference/config-jmx.md +++ b/docs/reference/config-jmx.md @@ -100,7 +100,7 @@ The resulting documents in Elasticsearch look similar to this: } ``` -[![dynamic config](../images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic) +[![dynamic config](/reference/images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic) | Default | Type | Dynamic | | --- | --- | --- | diff --git a/docs/reference/config-logging.md b/docs/reference/config-logging.md index b4331d59db..18eab94aed 100644 --- a/docs/reference/config-logging.md +++ b/docs/reference/config-logging.md @@ -17,7 +17,7 @@ Sets the logging level for the agent. This option is case-insensitive. :::: -[![dynamic config](../images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic) +[![dynamic config](/reference/images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic) Valid options: `OFF`, `ERROR`, `CRITICAL`, `WARN`, `WARNING`, `INFO`, `DEBUG`, `TRACE` @@ -73,7 +73,7 @@ while `SHADE` and `REPLACE` options are only relevant to file log appenders, the :::: -[![dynamic config](../images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic) +[![dynamic config](/reference/images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic) Valid options: `OFF`, `SHADE`, `REPLACE`, `OVERRIDE` @@ -189,7 +189,7 @@ Note that logs can get lost if the agent can’t keep up with the logs, if APM S For better delivery guarantees, it’s recommended to ship ECS JSON log files with Filebeat See also [`log_ecs_reformatting`](#config-log-ecs-reformatting). Log sending does not currently support custom MDC fields, `log_ecs_reformatting` and shipping the logs with Filebeat must be used if custom MDC fields are required. -[![dynamic config](../images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic) +[![dynamic config](/reference/images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic) | Default | Type | Dynamic | | --- | --- | --- | diff --git a/docs/reference/config-messaging.md b/docs/reference/config-messaging.md index daf3990de6..e28643e42e 100644 --- a/docs/reference/config-messaging.md +++ b/docs/reference/config-messaging.md @@ -16,7 +16,7 @@ This property should be set to an array containing one or more strings. When set This option supports the wildcard `*`, which matches zero or more characters. Examples: `/foo/*/bar/*/baz*`, `*foo*`. Matching is case insensitive by default. Prepending an element with `(?-i)` makes the matching case sensitive. -[![dynamic config](../images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic) +[![dynamic config](/reference/images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic) | Default | Type | Dynamic | | --- | --- | --- | @@ -48,7 +48,7 @@ Starting from version 1.43.0, the classes that are part of the *application_pack Defines whether the agent should use the exchanges, the routing key or the queue for the naming of RabbitMQ Transactions. Valid options are `QUEUE`, `ROUTING_KEY` and `EXCHANGE`. Note that `QUEUE` only works when using RabbitMQ via spring-amqp and `ROUTING_KEY` only works for the non spring-client. -[![dynamic config](../images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic) +[![dynamic config](/reference/images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic) Valid options: `EXCHANGE`, `QUEUE`, `ROUTING_KEY` diff --git a/docs/reference/config-metrics.md b/docs/reference/config-metrics.md index 6bddee1e6a..452703251b 100644 --- a/docs/reference/config-metrics.md +++ b/docs/reference/config-metrics.md @@ -17,7 +17,7 @@ Setting this to `false` can lead to mapping conflicts as dots indicate nesting i :::: -[![dynamic config](../images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic) +[![dynamic config](/reference/images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic) | Default | Type | Dynamic | | --- | --- | --- | diff --git a/docs/reference/config-profiling.md b/docs/reference/config-profiling.md index 350fc4194e..2eae1feec9 100644 --- a/docs/reference/config-profiling.md +++ b/docs/reference/config-profiling.md @@ -67,7 +67,7 @@ This feature is not available on Windows and on OpenJ9 :::: -[![dynamic config](../images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic) +[![dynamic config](/reference/images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic) | Default | Type | Dynamic | | --- | --- | --- | @@ -82,7 +82,7 @@ This feature is not available on Windows and on OpenJ9 By default, async profiler prints warning messages about missing JVM symbols to standard output. Set this option to `false` to suppress such messages -[![dynamic config](../images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic) +[![dynamic config](/reference/images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic) | Default | Type | Dynamic | | --- | --- | --- | @@ -97,7 +97,7 @@ By default, async profiler prints warning messages about missing JVM symbols to The frequency at which stack traces are gathered within a profiling session. The lower you set it, the more accurate the durations will be. This comes at the expense of higher overhead and more spans for potentially irrelevant operations. The minimal duration of a profiling-inferred span is the same as the value of this setting. -[![dynamic config](../images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic) +[![dynamic config](/reference/images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic) Supports the duration suffixes `ms`, `s` and `m`. Example: `50ms`. @@ -114,7 +114,7 @@ Supports the duration suffixes `ms`, `s` and `m`. Example: `50ms`. The minimum duration of an inferred span. Note that the min duration is also implicitly set by the sampling interval. However, increasing the sampling interval also decreases the accuracy of the duration of inferred spans. -[![dynamic config](../images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic) +[![dynamic config](/reference/images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic) Supports the duration suffixes `ms`, `s` and `m`. Example: `0ms`. @@ -133,7 +133,7 @@ If set, the agent will only create inferred spans for methods which match this l This option supports the wildcard `*`, which matches zero or more characters. Examples: `/foo/*/bar/*/baz*`, `*foo*`. Matching is case insensitive by default. Prepending an element with `(?-i)` makes the matching case sensitive. -[![dynamic config](../images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic) +[![dynamic config](/reference/images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic) | Default | Type | Dynamic | | --- | --- | --- | @@ -150,7 +150,7 @@ Excludes classes for which no profiler-inferred spans should be created. This option supports the wildcard `*`, which matches zero or more characters. Examples: `/foo/*/bar/*/baz*`, `*foo*`. Matching is case insensitive by default. Prepending an element with `(?-i)` makes the matching case sensitive. -[![dynamic config](../images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic) +[![dynamic config](/reference/images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic) | Default | Type | Dynamic | | --- | --- | --- | diff --git a/docs/reference/config-reporter.md b/docs/reference/config-reporter.md index 6a37a130ae..2dbe133159 100644 --- a/docs/reference/config-reporter.md +++ b/docs/reference/config-reporter.md @@ -14,7 +14,7 @@ This string is used to ensure that only your agents can send data to your APM se Both the agents and the APM server have to be configured with the same secret token. Use if APM Server requires a token. -[![dynamic config](../images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic) +[![dynamic config](/reference/images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic) | Default | Type | Dynamic | | --- | --- | --- | @@ -31,7 +31,7 @@ This string is used to ensure that only your agents can send data to your APM se Agents can use API keys as a replacement of secret token, APM server can have multiple API keys. When both secret token and API key are used, API key has priority and secret token is ignored. Use if APM Server requires an API key. -[![dynamic config](../images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic) +[![dynamic config](/reference/images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic) | Default | Type | Dynamic | | --- | --- | --- | @@ -55,7 +55,7 @@ This configuration can only be reloaded dynamically as of 1.8.0 :::: -[![dynamic config](../images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic) +[![dynamic config](/reference/images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic) | Default | Type | Dynamic | | --- | --- | --- | @@ -81,7 +81,7 @@ This configuration is specific to the Java agent and does not align with any oth :::: -[![dynamic config](../images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic) +[![dynamic config](/reference/images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic) | Default | Type | Dynamic | | --- | --- | --- | @@ -114,7 +114,7 @@ If timeouts are disabled or set to a high value, your app could experience memor :::: -[![dynamic config](../images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic) +[![dynamic config](/reference/images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic) Supports the duration suffixes `ms`, `s` and `m`. Example: `5s`. @@ -183,7 +183,7 @@ This value has to be lower than the APM Server’s `read_timeout` setting. :::: -[![dynamic config](../images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic) +[![dynamic config](/reference/images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic) Supports the duration suffixes `ms`, `s` and `m`. Example: `10s`. @@ -202,7 +202,7 @@ The maximum total compressed size of the request body which is sent to the APM s Allowed byte units are `b`, `kb` and `mb`. `1kb` is equal to `1024b`. -[![dynamic config](../images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic) +[![dynamic config](/reference/images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic) | Default | Type | Dynamic | | --- | --- | --- | diff --git a/docs/reference/config-stacktrace.md b/docs/reference/config-stacktrace.md index 18fadc63a6..7ab374ae24 100644 --- a/docs/reference/config-stacktrace.md +++ b/docs/reference/config-stacktrace.md @@ -25,7 +25,7 @@ the instrumentation aspect of this configuration option - specifying which class :::: -[![dynamic config](../images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic) +[![dynamic config](/reference/images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic) | Default | Type | Dynamic | | --- | --- | --- | @@ -40,7 +40,7 @@ the instrumentation aspect of this configuration option - specifying which class Setting it to 0 will disable stack trace collection. Any positive integer value will be used as the maximum number of frames to collect. Setting it -1 means that all frames will be collected. -[![dynamic config](../images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic) +[![dynamic config](/reference/images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic) | Default | Type | Dynamic | | --- | --- | --- | @@ -57,7 +57,7 @@ While this is very helpful to find the exact place in your code that causes the To disable stack trace collection for spans completely, set the value to `-1ms`. -[![dynamic config](../images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic) +[![dynamic config](/reference/images/dynamic-config.svg "") ](/reference/configuration.md#configuration-dynamic) Supports the duration suffixes `ms`, `s` and `m`. Example: `5ms`. diff --git a/docs/reference/configuration.md b/docs/reference/configuration.md index 7575057607..d04822c326 100644 --- a/docs/reference/configuration.md +++ b/docs/reference/configuration.md @@ -8,13 +8,13 @@ mapped_pages: To adapt the Elastic APM Java agent to your needs, you can configure it using one of the methods below, listed in descending order of precedence: 1) [Central configuration](docs-content://solutions/observability/apps/apm-agent-central-configuration.md) -: Configure the Agent in the Kibana APM app. [![dynamic config](images/dynamic-config.svg "") ](#configuration-dynamic) +: Configure the Agent in the Kibana APM app. [![dynamic config](/reference/images/dynamic-config.svg "") ](#configuration-dynamic) 2) Properties file -: The `elasticapm.properties` file is located in the same folder as the agent jar, or provided through the [`config_file`](/reference/config-core.md#config-config-file) option. ![dynamic config](../images/dynamic-config.svg "") +: The `elasticapm.properties` file is located in the same folder as the agent jar, or provided through the [`config_file`](/reference/config-core.md#config-config-file) option. ![dynamic config](/reference/images/dynamic-config.svg "") 3) Java system properties -: All configuration keys are prefixed with `elastic.apm.`
![dynamic config](../images/dynamic-config.svg "") +: All configuration keys are prefixed with `elastic.apm.`
![dynamic config](/reference/images/dynamic-config.svg "") 4) Environment variables : All configuration keys are in uppercase and prefixed with `ELASTIC_APM_`. @@ -29,7 +29,7 @@ To adapt the Elastic APM Java agent to your needs, you can configure it using on : Defined for each configuration. -## Dynamic configuration ![dynamic config](../images/dynamic-config.svg "") [configuration-dynamic] +## Dynamic configuration ![dynamic config](/reference/images/dynamic-config.svg "") [configuration-dynamic] Configuration options marked with Dynamic true can be changed at runtime when set from supported sources: From b3b005e18f473790d599ebfb4903f91f6020e91a Mon Sep 17 00:00:00 2001 From: Colleen McGinnis Date: Thu, 20 Mar 2025 18:26:50 -0500 Subject: [PATCH 5/6] fix image paths --- docs/reference/how-to-find-slow-methods.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/reference/how-to-find-slow-methods.md b/docs/reference/how-to-find-slow-methods.md index 9848a5c24f..a766618b96 100644 --- a/docs/reference/how-to-find-slow-methods.md +++ b/docs/reference/how-to-find-slow-methods.md @@ -15,7 +15,7 @@ Identifying a problematic service is only half of the battle when diagnosing app Find out which part of your code is making your application slow by periodically recording running methods with a sampling-based profiler. -![green check](images/green-check.svg "") Very low overhead.
![green check](../images/green-check.svg "") No code changes required.
![red x](images/red-x.svg "") Does not work on Windows and on OpenJ9.
![red x](../images/red-x.svg "") The duration of profiler-inferred spans are not exact measurements, only estimates. +![green check](/reference/images/green-check.svg "") Very low overhead.
![green check](/reference/images/green-check.svg "") No code changes required.
![red x](/reference/images/red-x.svg "") Does not work on Windows and on OpenJ9.
![red x](/reference/images/red-x.svg "") The duration of profiler-inferred spans are not exact measurements, only estimates. [Learn more](/reference/method-sampling-based.md) @@ -27,7 +27,7 @@ Find out which part of your code is making your application slow by periodically Use the API or OpenTracing bridge to manually create spans for methods of interest. -![green check](../images/green-check.svg "") Most flexible.
![red x](../images/red-x.svg "") Incorrect API usage may lead to invalid traces (scope leaks). +![green check](/reference/images/green-check.svg "") Most flexible.
![red x](/reference/images/red-x.svg "") Incorrect API usage may lead to invalid traces (scope leaks). [Learn more](/reference/method-api.md) @@ -36,7 +36,7 @@ Use the API or OpenTracing bridge to manually create spans for methods of intere Annotations can be placed on top of methods to automatically create spans for them. -![green check](../images/green-check.svg "") Easier and more robust than the API.
![red x](../images/red-x.svg "") Less flexible on its own, but can be combined with the API. +![green check](/reference/images/green-check.svg "") Easier and more robust than the API.
![red x](/reference/images/red-x.svg "") Less flexible on its own, but can be combined with the API. [Learn more](/reference/method-annotations.md) @@ -45,7 +45,7 @@ Annotations can be placed on top of methods to automatically create spans for th Use a configuration option to specify additional methods to instrument. -![green check](../images/green-check.svg "") No need to modify source code.
![green check](../images/green-check.svg "") Possible to monitor code in third-party libraries.
![green check](../images/green-check.svg "") Match methods via wildcards.
![red x](../images/red-x.svg "") Easy to overuse which hurts runtime and startup performance. +![green check](/reference/images/green-check.svg "") No need to modify source code.
![green check](/reference/images/green-check.svg "") Possible to monitor code in third-party libraries.
![green check](/reference/images/green-check.svg "") Match methods via wildcards.
![red x](/reference/images/red-x.svg "") Easy to overuse which hurts runtime and startup performance. [Learn more](/reference/method-config-based.md) From fc050e4b1e75c90d70e74393312a23f5ade5b9b9 Mon Sep 17 00:00:00 2001 From: Colleen McGinnis Date: Tue, 25 Mar 2025 08:10:05 -0500 Subject: [PATCH 6/6] clean up asciidoc-style links --- .../config-reference-properties-file.md | 22 +++++++++---------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/docs/reference/config-reference-properties-file.md b/docs/reference/config-reference-properties-file.md index 41cfa3cb9c..f5d8fbd63d 100644 --- a/docs/reference/config-reference-properties-file.md +++ b/docs/reference/config-reference-properties-file.md @@ -622,7 +622,7 @@ mapped_pages: # To enable {apm-guide-ref}/apm-distributed-tracing.html[distributed tracing], the agent # adds trace context headers to outgoing requests (like HTTP requests, Kafka records, gRPC requests etc.). # These headers (`traceparent` and `tracestate`) are defined in the -# https://www.w3.org/TR/trace-context-1/[W3C Trace Context] specification. +# [W3C Trace Context](https://www.w3.org/TR/trace-context-1/) specification. # # When this setting is `true`, the agent will also add the header `elastic-apm-traceparent` # for backwards compatibility with older versions of Elastic APM agents. @@ -940,14 +940,14 @@ mapped_pages: # * `object_name`: # + # For more information about the JMX object name pattern syntax, -# see the https://docs.oracle.com/javase/7/docs/api/javax/management/ObjectName.html[`ObjectName` Javadocs]. +# see the [`ObjectName` Javadocs](https://docs.oracle.com/javase/7/docs/api/javax/management/ObjectName.html). # * `attribute`: # + # The name of the JMX attribute. # The JMX value has to be either a `Number` or a composite where the composite items are numbers. # This element can be defined multiple times. # An attribute can contain optional properties. -# The syntax for that is the same as for https://docs.oracle.com/javase/7/docs/api/javax/management/ObjectName.html[`ObjectName`]. +# The syntax for that is the same as for [`ObjectName`](https://docs.oracle.com/javase/7/docs/api/javax/management/ObjectName.html). # + # ** `metric_name`: # + @@ -956,9 +956,9 @@ mapped_pages: # Setting this is optional and will be the same as the `attribute` if not set. # Note that all JMX metric names will be prefixed with `jvm.jmx.` by the agent. # -# The agent creates `labels` for each link:https://docs.oracle.com/javase/7/docs/api/javax/management/ObjectName.html#getKeyPropertyList()[JMX key property] such as `type` and `name`. +# The agent creates `labels` for each link:[JMX key property](https://docs.oracle.com/javase/7/docs/api/javax/management/ObjectName.html#getKeyPropertyList()) such as `type` and `name`. # -# The link:https://docs.oracle.com/javase/7/docs/api/javax/management/ObjectName.html[JMX object name pattern] supports wildcards. The attribute definition does NOT support wildcards, but a special definition `attribute[*]` is accepted (from 1.44.0) to mean match all possible (numeric) attributes for the associated object name pattern +# The link:[JMX object name pattern](https://docs.oracle.com/javase/7/docs/api/javax/management/ObjectName.html) supports wildcards. The attribute definition does NOT support wildcards, but a special definition `attribute[*]` is accepted (from 1.44.0) to mean match all possible (numeric) attributes for the associated object name pattern # The definition `object_name[*:type=*,name=*] attribute[*]` would match all possible JMX metrics # In the following example, the agent will create a metricset for each memory pool `name` (such as `G1 Old Generation` and `G1 Young Generation`) # @@ -1161,7 +1161,7 @@ mapped_pages: # Defines the log format when logging to `System.out`. # -# When set to `JSON`, the agent will format the logs in an https://github.com/elastic/ecs-logging-java[ECS-compliant JSON format] +# When set to `JSON`, the agent will format the logs in an [ECS-compliant JSON format](https://github.com/elastic/ecs-logging-java) # where each log event is serialized as a single line. # # Valid options: PLAIN_TEXT, JSON @@ -1173,7 +1173,7 @@ mapped_pages: # Defines the log format when logging to a file. # -# When set to `JSON`, the agent will format the logs in an https://github.com/elastic/ecs-logging-java[ECS-compliant JSON format] +# When set to `JSON`, the agent will format the logs in an [ECS-compliant JSON format](https://github.com/elastic/ecs-logging-java) # where each log event is serialized as a single line. # # Valid options: PLAIN_TEXT, JSON @@ -1326,7 +1326,7 @@ mapped_pages: # universal_profiling_integration_socket_dir= # Set to `true` to make the agent create spans for method executions based on -# https://github.com/jvm-profiling-tools/async-profiler[async-profiler], a sampling aka statistical profiler. +# [async-profiler](https://github.com/jvm-profiling-tools/async-profiler), a sampling aka statistical profiler. # # Due to the nature of how sampling profilers work, # the duration of the inferred spans are not exact, but only estimations. @@ -1405,7 +1405,7 @@ mapped_pages: # # profiling_inferred_spans_excluded_classes=(?-i)java.*,(?-i)javax.*,(?-i)sun.*,(?-i)com.sun.*,(?-i)jdk.*,(?-i)org.apache.tomcat.*,(?-i)org.apache.catalina.*,(?-i)org.apache.coyote.*,(?-i)org.jboss.as.*,(?-i)org.glassfish.*,(?-i)org.eclipse.jetty.*,(?-i)com.ibm.websphere.*,(?-i)io.undertow.* -# Profiling requires that the https://github.com/jvm-profiling-tools/async-profiler[async-profiler] shared library is exported to a temporary location and loaded by the JVM. +# Profiling requires that the [async-profiler](https://github.com/jvm-profiling-tools/async-profiler) shared library is exported to a temporary location and loaded by the JVM. # The partition backing this location must be executable, however in some server-hardened environments, `noexec` may be set on the standard `/tmp` partition, leading to `java.lang.UnsatisfiedLinkError` errors. # Set this property to an alternative directory (e.g. `/var/tmp`) to resolve this. # If unset, the value of the `java.io.tmpdir` system property will be used. @@ -1452,7 +1452,7 @@ mapped_pages: # # If outgoing HTTP traffic has to go through a proxy, # you can use the Java system properties `http.proxyHost` and `http.proxyPort` to set that up. -# See also https://docs.oracle.com/javase/8/docs/technotes/guides/net/proxies.html[Java's proxy documentation] +# See also [Java's proxy documentation](https://docs.oracle.com/javase/8/docs/technotes/guides/net/proxies.html) # for more information. # # NOTE: This configuration can only be reloaded dynamically as of 1.8.0 @@ -1476,7 +1476,7 @@ mapped_pages: # # If outgoing HTTP traffic has to go through a proxy, # you can use the Java system properties `http.proxyHost` and `http.proxyPort` to set that up. -# See also https://docs.oracle.com/javase/8/docs/technotes/guides/net/proxies.html[Java's proxy documentation] +# See also [Java's proxy documentation](https://docs.oracle.com/javase/8/docs/technotes/guides/net/proxies.html) # for more information. # # NOTE: This configuration is specific to the Java agent and does not align with any other APM agent. In order