From 6ac6171d5fceb517aea9e8928d864eec08787cc4 Mon Sep 17 00:00:00 2001 From: Gregor Zeitlinger Date: Fri, 26 Sep 2025 19:59:02 +0200 Subject: [PATCH 1/3] fix links --- .github/scripts/dependencies.dockerfile | 2 +- .lychee.toml | 7 +++++++ CHANGELOG.md | 4 ++-- docs/contributing/documenting-instrumentation.md | 6 +++--- docs/contributing/writing-instrumentation-module.md | 2 +- docs/supported-libraries.md | 10 +++++----- .../aws-lambda/aws-lambda-core-1.0/library/README.md | 2 +- .../aws-lambda/aws-lambda-events-2.2/library/README.md | 2 +- .../aws-lambda-events-3.11/library/README.md | 2 +- .../jetty-httpclient-12.0/library/README.md | 2 +- instrumentation/jmx-metrics/README.md | 6 +++--- instrumentation/jmx-metrics/library/jvm.md | 1 - instrumentation/resources/library/README.md | 2 +- .../spring-security-config-6.0/javaagent/README.md | 2 +- .../starters/zipkin-spring-boot-starter/README.md | 2 +- 15 files changed, 29 insertions(+), 23 deletions(-) diff --git a/.github/scripts/dependencies.dockerfile b/.github/scripts/dependencies.dockerfile index d8e3bbfe176b..e0a9a8627313 100644 --- a/.github/scripts/dependencies.dockerfile +++ b/.github/scripts/dependencies.dockerfile @@ -1,3 +1,3 @@ # this file exists so that Renovate can auto-update docker image versions that are then used elsewhere -FROM lycheeverse/lychee:sha-2aa22f8@sha256:2e3786630482c41f9f2dd081e06d7da1c36d66996e8cf6573409b8bc418d48c4 AS lychee +FROM lycheeverse/lychee:sha-8222559@sha256:6f49010cc46543af3b765f19d5319c0cdd4e8415d7596e1b401d5b4cec29c799 AS lychee diff --git a/.lychee.toml b/.lychee.toml index b5a5e45d618c..3dae59520edf 100644 --- a/.lychee.toml +++ b/.lychee.toml @@ -6,9 +6,16 @@ max_concurrency = 4 # Check link anchors include_fragments = true +remap = [ + # workaround for https://github.com/lycheeverse/lychee/issues/1729 + "https://github.com/(.*?)/(.*?)/blob/(.*?)/(.*#.*)$ https://raw.githubusercontent.com/$1/$2/$3/$4" +] + # excluding links to pull requests and issues is done for performance # stackexchange link fails with 403 when accessed by lychee exclude = [ + # workaround for https://github.com/lycheeverse/lychee/issues/1729 + '^https://github.com/.*#issuecomment-.*$', '^https://github.com/open-telemetry/opentelemetry-java-instrumentation/(issues|pull)/\d+$', '^http://code.google.com/p/concurrentlinkedhashmap$', '^https://softwareengineering.stackexchange.com/questions/29727.*', diff --git a/CHANGELOG.md b/CHANGELOG.md index f51aa5ad6ba0..e6c8f6b253e1 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -369,7 +369,7 @@ ### 🌟 New javaagent instrumentation - AWS Bedrock instrumentation, following - [Gen AI semantic conventions](https://github.com/open-telemetry/semantic-conventions/tree/main/docs/gen-ai#semantic-conventions-for-generative-ai-systems) + [Gen AI semantic conventions](https://github.com/open-telemetry/semantic-conventions/blob/main/docs/gen-ai/README.md#semantic-conventions-for-generative-ai-systems) ([#13355](https://github.com/open-telemetry/opentelemetry-java-instrumentation/pull/13355), [#13408](https://github.com/open-telemetry/opentelemetry-java-instrumentation/pull/13408), [#13473](https://github.com/open-telemetry/opentelemetry-java-instrumentation/pull/13473), @@ -382,7 +382,7 @@ ### 🌟 New library instrumentation - AWS Bedrock instrumentation, following - [Gen AI semantic conventions](https://github.com/open-telemetry/semantic-conventions/tree/main/docs/gen-ai#semantic-conventions-for-generative-ai-systems) + [Gen AI semantic conventions](https://github.com/open-telemetry/semantic-conventions/blob/main/docs/gen-ai/README.md#semantic-conventions-for-generative-ai-systems) ([#13355](https://github.com/open-telemetry/opentelemetry-java-instrumentation/pull/13355), [#13408](https://github.com/open-telemetry/opentelemetry-java-instrumentation/pull/13408), [#13473](https://github.com/open-telemetry/opentelemetry-java-instrumentation/pull/13473), diff --git a/docs/contributing/documenting-instrumentation.md b/docs/contributing/documenting-instrumentation.md index 27640667de76..705b1cb2c19e 100644 --- a/docs/contributing/documenting-instrumentation.md +++ b/docs/contributing/documenting-instrumentation.md @@ -156,13 +156,13 @@ If the instrumentation adheres to one or more specific semantic conventions, inc List of possible options: -* [HTTP_CLIENT_SPANS](https://github.com/open-telemetry/semantic-conventions/blob/main/docs/http/http-spans.md#http-client) +* [HTTP_CLIENT_SPANS](https://github.com/open-telemetry/semantic-conventions/blob/main/docs/http/http-spans.md#http-client-span) * [HTTP_CLIENT_METRICS](https://github.com/open-telemetry/semantic-conventions/blob/main/docs/http/http-metrics.md#http-client) * [HTTP_SERVER_SPANS](https://github.com/open-telemetry/semantic-conventions/blob/main/docs/http/http-spans.md#http-server) * [HTTP_SERVER_METRICS](https://github.com/open-telemetry/semantic-conventions/blob/main/docs/http/http-metrics.md#http-server) -* [RPC_CLIENT_SPANS](https://github.com/open-telemetry/semantic-conventions/blob/main/docs/rpc/rpc-spans.md#client-attributes) +* [RPC_CLIENT_SPANS](https://github.com/open-telemetry/semantic-conventions/blob/main/docs/rpc/rpc-spans.md#rpc-client-span) * [RPC_CLIENT_METRICS](https://github.com/open-telemetry/semantic-conventions/blob/main/docs/rpc/rpc-metrics.md#rpc-client) -* [RPC_SERVER_SPANS](https://github.com/open-telemetry/semantic-conventions/blob/main/docs/rpc/rpc-spans.md#server-attributes) +* [RPC_SERVER_SPANS](https://github.com/open-telemetry/semantic-conventions/blob/main/docs/rpc/rpc-spans.md#rpc-server-span) * [RPC_SERVER_METRICS](https://github.com/open-telemetry/semantic-conventions/blob/main/docs/rpc/rpc-metrics.md#rpc-server) * [MESSAGING_SPANS](https://github.com/open-telemetry/semantic-conventions/blob/main/docs/messaging/messaging-spans.md) * [DATABASE_CLIENT_SPANS](https://github.com/open-telemetry/semantic-conventions/blob/main/docs/database/database-spans.md) diff --git a/docs/contributing/writing-instrumentation-module.md b/docs/contributing/writing-instrumentation-module.md index 3157d1a26de2..ffbf3dbfc2a5 100644 --- a/docs/contributing/writing-instrumentation-module.md +++ b/docs/contributing/writing-instrumentation-module.md @@ -359,7 +359,7 @@ For example: @Advice.Origin("#m") String methodName ``` -[suppress]: https://opentelemetry.io/docs/instrumentation/java/automatic/agent-config/#suppressing-specific-auto-instrumentation +[suppress]: https://opentelemetry.io/docs/zero-code/java/agent/disable/#suppressing-specific-agent-instrumentation ## Use non-inlined advice code with `invokedynamic` diff --git a/docs/supported-libraries.md b/docs/supported-libraries.md index b32ed049daa2..b9b686070ffd 100644 --- a/docs/supported-libraries.md +++ b/docs/supported-libraries.md @@ -139,7 +139,7 @@ These are the supported libraries and frameworks: | [Spring Core](https://docs.spring.io/spring-framework/docs/current/javadoc-api/org/springframework/core/package-summary.html) | 2.0+ | N/A | Context propagation | | [Spring Data](https://spring.io/projects/spring-data) | 1.8+ | N/A | none | | [Spring Integration](https://spring.io/projects/spring-integration) | 4.1+ (not including 6.0+ yet) | [opentelemetry-spring-integration-4.1](../instrumentation/spring/spring-integration-4.1/library) | [Messaging Spans] | -| [Spring JMS](https://docs.spring.io/spring-framework/docs/current/reference/html/integration.html#jms) | 2.0+ | N/A | [Messaging Spans] | +| [Spring JMS](https://docs.spring.io/spring-framework/reference/integration/jms.html) | 2.0+ | N/A | [Messaging Spans] | | [Spring Kafka](https://spring.io/projects/spring-kafka) | 2.7+ | [opentelemetry-spring-kafka-2.7](../instrumentation/spring/spring-kafka-2.7/library) | [Messaging Spans] | | [Spring Pulsar](https://spring.io/projects/spring-pulsar) | 1.0+ | | [Messaging Spans] | | [Spring RabbitMQ](https://spring.io/projects/spring-amqp) | 1.0+ | N/A | [Messaging Spans] | @@ -168,7 +168,7 @@ These are the supported libraries and frameworks: **[2]** Provides `http.route`: Provides route-based span name for existing `SERVER` span. If applicable, provides `http.route` span and metric attribute on existing `SERVER` span and metrics. -**[3]** Controller Spans are `INTERNAL` spans capturing the controller and/or view execution. See [Suppressing controller and/or view spans](https://opentelemetry.io/docs/instrumentation/java/automatic/agent-config/#suppressing-controller-andor-view-spans). +**[3]** Controller Spans are `INTERNAL` spans capturing the controller and/or view execution. See [Suppressing controller and/or view spans](https://opentelemetry.io/docs/zero-code/java/agent/disable/#suppressing-controller-andor-view-spans). **[4]** Newer versions of the library have telemetry built-in. @@ -178,11 +178,11 @@ These are the supported libraries and frameworks: [Elasticsearch Client Spans]: https://github.com/open-telemetry/semantic-conventions/blob/main/docs/database/elasticsearch.md [HTTP Server Spans]: https://github.com/open-telemetry/semantic-conventions/blob/main/docs/http/http-spans.md#http-server -[HTTP Client Spans]: https://github.com/open-telemetry/semantic-conventions/blob/main/docs/http/http-spans.md#http-client +[HTTP Client Spans]: https://github.com/open-telemetry/semantic-conventions/blob/main/docs/http/http-spans.md#http-client-span [HTTP Server Metrics]: https://github.com/open-telemetry/semantic-conventions/blob/main/docs/http/http-metrics.md#http-server [HTTP Client Metrics]: https://github.com/open-telemetry/semantic-conventions/blob/main/docs/http/http-metrics.md#http-client -[RPC Server Spans]: https://github.com/open-telemetry/semantic-conventions/blob/main/docs/rpc/rpc-spans.md#server-attributes -[RPC Client Spans]: https://github.com/open-telemetry/semantic-conventions/blob/main/docs/rpc/rpc-spans.md#client-attributes +[RPC Server Spans]: https://github.com/open-telemetry/semantic-conventions/blob/main/docs/rpc/rpc-spans.md#rpc-server-span +[RPC Client Spans]: https://github.com/open-telemetry/semantic-conventions/blob/main/docs/rpc/rpc-spans.md#rpc-client-span [RPC Server Metrics]: https://github.com/open-telemetry/semantic-conventions/blob/main/docs/rpc/rpc-metrics.md#rpc-server [RPC Client Metrics]: https://github.com/open-telemetry/semantic-conventions/blob/main/docs/rpc/rpc-metrics.md#rpc-client [Messaging Spans]: https://github.com/open-telemetry/semantic-conventions/blob/main/docs/messaging/messaging-spans.md diff --git a/instrumentation/aws-lambda/aws-lambda-core-1.0/library/README.md b/instrumentation/aws-lambda/aws-lambda-core-1.0/library/README.md index c0ee14cedcd2..dcbf60ebebba 100644 --- a/instrumentation/aws-lambda/aws-lambda-core-1.0/library/README.md +++ b/instrumentation/aws-lambda/aws-lambda-core-1.0/library/README.md @@ -100,4 +100,4 @@ In order to enable requested propagation for a handler, configure it on the SDK } ``` -If using the wrappers, set the `OTEL_PROPAGATORS` environment variable as described [here](https://github.com/open-telemetry/opentelemetry-java/blob/main/sdk-extensions/autoconfigure/README.md#propagator). +If using the wrappers, set the `OTEL_PROPAGATORS` environment variable as described [here](https://opentelemetry.io/docs/languages/sdk-configuration/general/#otel_propagators). diff --git a/instrumentation/aws-lambda/aws-lambda-events-2.2/library/README.md b/instrumentation/aws-lambda/aws-lambda-events-2.2/library/README.md index 0f33c6df923a..a0d27f31d255 100644 --- a/instrumentation/aws-lambda/aws-lambda-events-2.2/library/README.md +++ b/instrumentation/aws-lambda/aws-lambda-events-2.2/library/README.md @@ -131,4 +131,4 @@ In order to enable requested propagation for a handler, configure it on the SDK } ``` -If using the wrappers, set the `OTEL_PROPAGATORS` environment variable as described [here](https://github.com/open-telemetry/opentelemetry-java/blob/main/sdk-extensions/autoconfigure/README.md#propagator). +If using the wrappers, set the `OTEL_PROPAGATORS` environment variable as described [here](https://opentelemetry.io/docs/languages/sdk-configuration/general/#otel_propagators). diff --git a/instrumentation/aws-lambda/aws-lambda-events-3.11/library/README.md b/instrumentation/aws-lambda/aws-lambda-events-3.11/library/README.md index cbde50929e96..4c4741a86f4d 100644 --- a/instrumentation/aws-lambda/aws-lambda-events-3.11/library/README.md +++ b/instrumentation/aws-lambda/aws-lambda-events-3.11/library/README.md @@ -133,4 +133,4 @@ In order to enable requested propagation for a handler, configure it on the SDK } ``` -If using the wrappers, set the `OTEL_PROPAGATORS` environment variable as described [here](https://github.com/open-telemetry/opentelemetry-java/blob/main/sdk-extensions/autoconfigure/README.md#propagator). +If using the wrappers, set the `OTEL_PROPAGATORS` environment variable as described [here](https://opentelemetry.io/docs/languages/sdk-configuration/general/#otel_propagators). diff --git a/instrumentation/jetty-httpclient/jetty-httpclient-12.0/library/README.md b/instrumentation/jetty-httpclient/jetty-httpclient-12.0/library/README.md index e5c86f7bbbb7..0302fba6fab0 100644 --- a/instrumentation/jetty-httpclient/jetty-httpclient-12.0/library/README.md +++ b/instrumentation/jetty-httpclient/jetty-httpclient-12.0/library/README.md @@ -1,6 +1,6 @@ # Library Instrumentation for Jetty HttpClient version 12.0 and higher -Provides OpenTelemetry instrumentation for the [Jetty HttpClient](https://www.eclipse.org/jetty/documentation/jetty-12/programming-guide/index.html#pg-client-http), +Provides OpenTelemetry instrumentation for the [Jetty HttpClient](https://jetty.org/docs/jetty/12/programming-guide/client/http.html), enabling database client spans and metrics. ## Quickstart diff --git a/instrumentation/jmx-metrics/README.md b/instrumentation/jmx-metrics/README.md index 96a2ae1f06fa..e1edc1fc6c14 100644 --- a/instrumentation/jmx-metrics/README.md +++ b/instrumentation/jmx-metrics/README.md @@ -351,7 +351,7 @@ rules: ### Filtering negative values Sometimes a negative value is returned by the MBean implementation when a metric is not available or not supported. -For example, [`OperatingSystemMXBean.getProcessCpuLoad`](https://docs.oracle.com/javase/7/docs/jre/api/management/extension/com/sun/management/OperatingSystemMXBean.html#getProcessCpuLoad()) can return a negative value. +For example, [`OperatingSystemMXBean.getProcessCpuLoad`](https://docs.oracle.com/javase/7/docs/jre/api/management/extension/com/sun/management/OperatingSystemMXBean.html) can return a negative value. In this case, it is recommended to filter out the negative values by setting the `dropNegativeValues` metric (or rule) property to `true`, it is set to `false` by default. @@ -449,12 +449,12 @@ The following table explains the used terms with more details. | Syntactic Element | Description | |--------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| OBJECTNAME | A syntactically valid string representing an ObjectName (see [ObjectName constructor](https://docs.oracle.com/javase/8/docs/api/javax/management/ObjectName.html#ObjectName-java.lang.String-)). | +| OBJECTNAME | A syntactically valid string representing an ObjectName (see [ObjectName constructor](https://docs.oracle.com/javase/8/docs/api/javax/management/ObjectName.html)). | | ATTRIBUTE | Any well-formed string that can be used as a metric [attribute](https://opentelemetry.io/docs/reference/specification/common/#attribute) key. | | ATTR | A non-empty string used as a name of the MBean attribute. The MBean attribute value must be a String, otherwise the specified metric attribute will not be used. | | PARAM | A non-empty string used as a property key in the ObjectName identifying the MBean which provides the metric value. If the ObjectName does not have a property with the given key, the specified metric attribute will not be used. | | METRIC_NAME_PREFIX | Any non-empty string which will be prepended to the specified metric (instrument) names. | -| METRIC_NAME | Any non-empty string. The string, prefixed by the optional prefix (see above) must satisfy [instrument naming rule](https://opentelemetry.io/docs/reference/specification/metrics/api/#instrument-naming-rule). | +| METRIC_NAME | Any non-empty string. The string, prefixed by the optional prefix (see above) must satisfy [instrument naming rule](https://opentelemetry.io/docs/specs/otel/metrics/api/#instrument-name-syntax). | | TYPE | One of `counter`, `updowncounter`, or `gauge`. The default is `gauge`. This value is case insensitive. | | DESCRIPTION | Any string to be used as human-readable [description](https://opentelemetry.io/docs/reference/specification/metrics/api/#instrument-description) of the metric. If the description is not provided by the rule, an attempt will be made to extract one automatically from the corresponding MBean. | | UNIT | A string identifying the [unit](https://opentelemetry.io/docs/reference/specification/metrics/api/#instrument-unit) of measurements reported by the metric. Enclose the string in single or double quotes if using unit annotations. | diff --git a/instrumentation/jmx-metrics/library/jvm.md b/instrumentation/jmx-metrics/library/jvm.md index d21eb2dfa3bc..6a67222ac1fa 100644 --- a/instrumentation/jmx-metrics/library/jvm.md +++ b/instrumentation/jmx-metrics/library/jvm.md @@ -23,7 +23,6 @@ Those metrics are defined in the [JVM runtime metrics semantic conventions](http | [jvm.system.cpu.recent_utilization](https://opentelemetry.io/docs/specs/semconv/runtime/jvm-metrics/#metric-jvmcpurecent_utilization) | experimental | Gauge | | Recent CPU utilization reported by JVM | | [jvm.buffer.memory.used](https://opentelemetry.io/docs/specs/semconv/runtime/jvm-metrics/#metric-jvmbuffermemoryused) | experimental | UpDownCounter | jvm.buffer.pool.name | Memory used by buffers | | [jvm.buffer.memory.limit](https://opentelemetry.io/docs/specs/semconv/runtime/jvm-metrics/#metric-jvmbuffermemorylimit) | experimental | UpDownCounter | jvm.buffer.pool.name | Maximum memory usage for buffers | -| [jvm.buffer.memory.count](https://opentelemetry.io/docs/specs/semconv/runtime/jvm-metrics/#metric-jvmbuffermemorycount) | experimental | UpDownCounter | jvm.buffer.pool.name | Buffers count | ## Limitations and unsupported metrics diff --git a/instrumentation/resources/library/README.md b/instrumentation/resources/library/README.md index 883f40ce0626..3c9cf8e9d1ce 100644 --- a/instrumentation/resources/library/README.md +++ b/instrumentation/resources/library/README.md @@ -86,4 +86,4 @@ Implemented attributes: This package currently does not run on Android. It has been verified on OpenJDK and should work on other server JVM distributions but if you find any issues please let us know. -[declarative config]: https://github.com/open-telemetry/opentelemetry-specification/tree/main/specification/configuration#declarative-configuration +[declarative config]: https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/configuration/README.md#declarative-configuration diff --git a/instrumentation/spring/spring-security-config-6.0/javaagent/README.md b/instrumentation/spring/spring-security-config-6.0/javaagent/README.md index 892f5367d500..0d3c062ba019 100644 --- a/instrumentation/spring/spring-security-config-6.0/javaagent/README.md +++ b/instrumentation/spring/spring-security-config-6.0/javaagent/README.md @@ -5,7 +5,7 @@ from Spring Security `Authentication` objects. ## Settings -This module honors the [common `otel.instrumentation.common.enduser.*` properties](https://opentelemetry.io/docs/instrumentation/java/automatic/agent-config/#common-instrumentation-configuration) +This module honors the [common `otel.instrumentation.common.enduser.*` properties](https://opentelemetry.io/docs/zero-code/java/agent/instrumentation/#capturing-enduser-attributes) and the following properties: | Property | Type | Default | Description | diff --git a/instrumentation/spring/starters/zipkin-spring-boot-starter/README.md b/instrumentation/spring/starters/zipkin-spring-boot-starter/README.md index 44c1ad838ff9..db8eadaac670 100644 --- a/instrumentation/spring/starters/zipkin-spring-boot-starter/README.md +++ b/instrumentation/spring/starters/zipkin-spring-boot-starter/README.md @@ -4,4 +4,4 @@ The OpenTelemetry Exporter Starter for Java is a starter package that includes p OpenTelemetry Zipkin Exporter Starter is a starter package that includes the opentelemetry-api, opentelemetry-sdk, opentelemetry-extension-annotations, opentelemetry-logging-exporter, opentelemetry-spring-boot-autoconfigurations and spring framework starters required to setup distributed tracing. It also provides the [opentelemetry-exporters-zipkin](https://github.com/open-telemetry/opentelemetry-java/tree/main/exporters/zipkin) artifact and corresponding exporter auto-configuration. -Documentation for the OpenTelemetry Zipkin Exporter Starter can be found [here](https://opentelemetry.io/docs/zero-code/java/spring-boot/#zipkin-starter). +Documentation for the OpenTelemetry Zipkin Exporter Starter can be found [here](https://opentelemetry.io/docs/zero-code/java/spring-boot-starter/other-spring-autoconfig/#zipkin-starter). From f6e18c0825f4b91241392f9f57abb0ec3a29fa7b Mon Sep 17 00:00:00 2001 From: Gregor Zeitlinger Date: Fri, 26 Sep 2025 20:26:14 +0200 Subject: [PATCH 2/3] Update instrumentation/jmx-metrics/README.md Co-authored-by: Trask Stalnaker --- instrumentation/jmx-metrics/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/instrumentation/jmx-metrics/README.md b/instrumentation/jmx-metrics/README.md index e1edc1fc6c14..47fd42a65ce6 100644 --- a/instrumentation/jmx-metrics/README.md +++ b/instrumentation/jmx-metrics/README.md @@ -449,7 +449,7 @@ The following table explains the used terms with more details. | Syntactic Element | Description | |--------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| OBJECTNAME | A syntactically valid string representing an ObjectName (see [ObjectName constructor](https://docs.oracle.com/javase/8/docs/api/javax/management/ObjectName.html)). | +| OBJECTNAME | A syntactically valid string representing an [ObjectName](https://docs.oracle.com/javase/8/docs/api/javax/management/ObjectName.html). | | ATTRIBUTE | Any well-formed string that can be used as a metric [attribute](https://opentelemetry.io/docs/reference/specification/common/#attribute) key. | | ATTR | A non-empty string used as a name of the MBean attribute. The MBean attribute value must be a String, otherwise the specified metric attribute will not be used. | | PARAM | A non-empty string used as a property key in the ObjectName identifying the MBean which provides the metric value. If the ObjectName does not have a property with the given key, the specified metric attribute will not be used. | From 50ad2e9f04c249e9eea960ea4d3bd8d941ac0739 Mon Sep 17 00:00:00 2001 From: Gregor Zeitlinger Date: Fri, 26 Sep 2025 20:27:12 +0200 Subject: [PATCH 3/3] fix links --- .lychee.toml | 1 + instrumentation/jmx-metrics/README.md | 4 ++-- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/.lychee.toml b/.lychee.toml index 3dae59520edf..03112c7582ff 100644 --- a/.lychee.toml +++ b/.lychee.toml @@ -16,6 +16,7 @@ remap = [ exclude = [ # workaround for https://github.com/lycheeverse/lychee/issues/1729 '^https://github.com/.*#issuecomment-.*$', + '^https://docs.oracle.com/.*$', '^https://github.com/open-telemetry/opentelemetry-java-instrumentation/(issues|pull)/\d+$', '^http://code.google.com/p/concurrentlinkedhashmap$', '^https://softwareengineering.stackexchange.com/questions/29727.*', diff --git a/instrumentation/jmx-metrics/README.md b/instrumentation/jmx-metrics/README.md index 47fd42a65ce6..0ac449a32f7a 100644 --- a/instrumentation/jmx-metrics/README.md +++ b/instrumentation/jmx-metrics/README.md @@ -351,7 +351,7 @@ rules: ### Filtering negative values Sometimes a negative value is returned by the MBean implementation when a metric is not available or not supported. -For example, [`OperatingSystemMXBean.getProcessCpuLoad`](https://docs.oracle.com/javase/7/docs/jre/api/management/extension/com/sun/management/OperatingSystemMXBean.html) can return a negative value. +For example, [`OperatingSystemMXBean.getProcessCpuLoad`](https://docs.oracle.com/javase/7/docs/jre/api/management/extension/com/sun/management/OperatingSystemMXBean.html#getProcessCpuLoad()) can return a negative value. In this case, it is recommended to filter out the negative values by setting the `dropNegativeValues` metric (or rule) property to `true`, it is set to `false` by default. @@ -449,7 +449,7 @@ The following table explains the used terms with more details. | Syntactic Element | Description | |--------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| OBJECTNAME | A syntactically valid string representing an [ObjectName](https://docs.oracle.com/javase/8/docs/api/javax/management/ObjectName.html). | +| OBJECTNAME | A syntactically valid string representing an [ObjectName](https://docs.oracle.com/javase/8/docs/api/javax/management/ObjectName.html#ObjectName-java.lang.String-). | | ATTRIBUTE | Any well-formed string that can be used as a metric [attribute](https://opentelemetry.io/docs/reference/specification/common/#attribute) key. | | ATTR | A non-empty string used as a name of the MBean attribute. The MBean attribute value must be a String, otherwise the specified metric attribute will not be used. | | PARAM | A non-empty string used as a property key in the ObjectName identifying the MBean which provides the metric value. If the ObjectName does not have a property with the given key, the specified metric attribute will not be used. |