diff --git a/.github/copilot-instructions.md b/.github/copilot-instructions.md index d7f693363..4de54aa10 100644 --- a/.github/copilot-instructions.md +++ b/.github/copilot-instructions.md @@ -63,4 +63,4 @@ When implementing changes or new features: 1. Follow all [Style Guide](../docs/style-guide.md) conventions and the Code Review Priorities above 2. Run tests to ensure they still pass (use `./gradlew test` and `./gradlew integrationTest` as needed) 3. **Always run `./gradlew spotlessApply`** after making code changes to ensure proper formatting -4. Run markdown lint to ensure it still passes: `npx markdownlint-cli@0.45.0 -c .github/config/markdownlint.yml **/*.md` +4. Run markdown lint to ensure it still passes: `npx markdownlint-cli@0.46.0 -c .github/config/markdownlint.yml **/*.md` diff --git a/.github/workflows/reusable-markdown-lint.yml b/.github/workflows/reusable-markdown-lint.yml index 9160e84b1..5b092b55f 100644 --- a/.github/workflows/reusable-markdown-lint.yml +++ b/.github/workflows/reusable-markdown-lint.yml @@ -14,4 +14,4 @@ jobs: - name: Run markdownlint run: | - npx markdownlint-cli@0.45.0 -c .github/config/markdownlint.yml **/*.md + npx markdownlint-cli@0.46.0 -c .github/config/markdownlint.yml **/*.md diff --git a/jmx-metrics/README.md b/jmx-metrics/README.md index a9cab0d47..94fb27037 100644 --- a/jmx-metrics/README.md +++ b/jmx-metrics/README.md @@ -75,7 +75,7 @@ capable of being specified via the `otel.jmx.target.system` property as a comma- currently supported target systems are: | `otel.jmx.target.system` | -|--------------------------| +| ------------------------ | | [`jvm`](./docs/target-systems/jvm.md) | | [`activemq`](./docs/target-systems/activemq.md) | | [`cassandra`](./docs/target-systems/cassandra.md) | @@ -257,7 +257,7 @@ file contents can also be provided via stdin on startup when using `-config -` a | Property | Required | Description | | ------------- | -------- | ----------- | -| `otel.jmx.service.url` | **yes** | The service URL for the JMX RMI/JMXMP endpoint (generally of the form `service:jmx:rmi:///jndi/rmi://:/jmxrmi` or `service:jmx:jmxmp://:`).| +| `otel.jmx.service.url` | **yes** | The service URL for the JMX RMI/JMXMP endpoint (generally of the form `service:jmx:rmi:///jndi/rmi://:/jmxrmi` or `service:jmx:jmxmp://:`). | | `otel.jmx.groovy.script` | if not using `otel.jmx.target.system` | The path for the desired Groovy script. | | `otel.jmx.target.system` | if not using `otel.jmx.groovy.script` | A comma-separated list of the supported target applications with built in Groovy scripts. | | `otel.jmx.interval.milliseconds` | no | How often, in milliseconds, the Groovy script should be run. Value will also be used for `otel.metric.export.interval`, if unset, to control asynchronous updates and metric exporting. 10000 by default. | @@ -265,12 +265,12 @@ file contents can also be provided via stdin on startup when using `-config -` a | `otel.jmx.password` | no | Password for JMX authentication, if applicable. | | `otel.jmx.remote.profile` | no | Supported JMX remote profiles are TLS in combination with SASL profiles: SASL/PLAIN, SASL/DIGEST-MD5 and SASL/CRAM-MD5. Thus valid `jmxRemoteProfiles` values are: `SASL/PLAIN`, `SASL/DIGEST-MD5`, `SASL/CRAM-MD5`, `TLS SASL/PLAIN`, `TLS SASL/DIGEST-MD5` and `TLS SASL/CRAM-MD5`. | | `otel.jmx.realm` | no | The realm is required by profile SASL/DIGEST-MD5. | -| `otel.metrics.exporter` | no | The type of metric exporter to use: (`otlp`, `prometheus`, `inmemory`, `logging`). `logging` by default. | -| `otel.exporter.otlp.endpoint` | no | The otlp exporter endpoint to use, Required for `otlp`. | -| `otel.exporter.otlp.headers` | no | Any headers to include in otlp exporter metric submissions. Of the form `header1=value1,header2=value2` | -| `otel.exporter.otlp.timeout` | no | The otlp exporter request timeout (in milliseconds). Default is 1000. | -| `otel.exporter.prometheus.host` | no | The prometheus collector server host. Default is `0.0.0.0`. | -| `otel.exporter.prometheus.port` | no | The prometheus collector server port. Default is `9464`. | +| `otel.metrics.exporter` | no | The type of metric exporter to use: (`otlp`, `prometheus`, `inmemory`, `logging`). `logging` by default. | +| `otel.exporter.otlp.endpoint` | no | The otlp exporter endpoint to use, Required for `otlp`. | +| `otel.exporter.otlp.headers` | no | Any headers to include in otlp exporter metric submissions. Of the form `header1=value1,header2=value2` | +| `otel.exporter.otlp.timeout` | no | The otlp exporter request timeout (in milliseconds). Default is 1000. | +| `otel.exporter.prometheus.host` | no | The prometheus collector server host. Default is `0.0.0.0`. | +| `otel.exporter.prometheus.port` | no | The prometheus collector server port. Default is `9464`. | | `javax.net.ssl.keyStore` | no | The key store path is required if client authentication is enabled on the target JVM. | | `javax.net.ssl.keyStorePassword` | no | The key store file password if required. | | `javax.net.ssl.keyStoreType` | no | The key store type. | diff --git a/jmx-scraper/README.md b/jmx-scraper/README.md index 6ba91a400..287dbad74 100644 --- a/jmx-scraper/README.md +++ b/jmx-scraper/README.md @@ -73,7 +73,7 @@ Supported values for `otel.jmx.target.system` and support for `otel.jmx.target.s | `activemq` | Apache ActiveMQ | [`activemq.yaml`](src/main/resources/activemq.yaml) | | | `cassandra` | Apache Cassandra | [`cassandra.yaml`](src/main/resources/cassandra.yaml) | | | `hbase` | Apache HBase | [`hbase.yaml`](src/main/resources/hbase.yaml) | | -| `hadoop` | Apache Hadoop | [`hadoop.yaml`](src/main/resources/hadoop.yaml) | [`hadoop.yaml`](https://github.com/open-telemetry/opentelemetry-java-instrumentation/blob/main/instrumentation/jmx-metrics/library/src/main/resources/jmx/rules/hadoop.yaml) ([doc](https://github.com/open-telemetry/opentelemetry-java-instrumentation/blob/main/instrumentation/jmx-metrics/library/hadoop.md)) | +| `hadoop` | Apache Hadoop | [`hadoop.yaml`](src/main/resources/hadoop.yaml) | [`hadoop.yaml`](https://github.com/open-telemetry/opentelemetry-java-instrumentation/blob/main/instrumentation/jmx-metrics/library/src/main/resources/jmx/rules/hadoop.yaml) ([doc](https://github.com/open-telemetry/opentelemetry-java-instrumentation/blob/main/instrumentation/jmx-metrics/library/hadoop.md)) | | `jetty` | Eclipse Jetty | [`jetty.yaml`](src/main/resources/jetty.yaml) | [`jetty.yaml`](https://github.com/open-telemetry/opentelemetry-java-instrumentation/blob/main/instrumentation/jmx-metrics/library/src/main/resources/jmx/rules/jetty.yaml) ([doc](https://github.com/open-telemetry/opentelemetry-java-instrumentation/blob/main/instrumentation/jmx-metrics/library/jetty.md)) | | `jvm` | JVM runtime metrics | [`jvm.yaml`](src/main/resources/jvm.yaml) | [`jvm.yaml`](https://github.com/open-telemetry/opentelemetry-java-instrumentation/blob/main/instrumentation/jmx-metrics/library/src/main/resources/jmx/rules/jvm.yaml) ([doc](https://github.com/open-telemetry/opentelemetry-java-instrumentation/blob/main/instrumentation/jmx-metrics/library/jvm.md)) | | `kafka` | Apache Kafka | [`kafka.yaml`](src/main/resources/kafka.yaml) | | diff --git a/maven-extension/README.md b/maven-extension/README.md index fd0150355..6089776ed 100644 --- a/maven-extension/README.md +++ b/maven-extension/README.md @@ -105,26 +105,26 @@ Distributed trace of a Jenkins pipeline invoking a Maven build instrumented with In addition to the span attributes captured on every Maven plugin goal execution as described above: -| Span attribute | Type | Description | -|----------------------------------------|--------|-----------------------------------------------------------------------------------------------------------------------------------------------------| -| `http.method` | string | `POST` | -| `http.url` | string | Base URL of the uploaded artifact `${maven.build.repository.url}/${groupId}/${artifactId}/${version}` where the `.` of `${groupId}` are replaced by `/` | -| `maven.build.repository.id` | string | ID of the Maven repository to which the artifact is deployed. See [Maven POM reference / Repository](https://maven.apache.org/pom.html#Repository) | -| `maven.build.repository.url` | string | URL of the Maven repository to which the artifact is deployed. See [Maven POM reference / Repository](https://maven.apache.org/pom.html#Repository) | -| `peer.service` | string | Maven repository hostname deduced from the Repository URL | +| Span attribute | Type | Description | +|----------------------------------------|--------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------- --| +| `http.method` | string | `POST` | +| `http.url` | string | Base URL of the uploaded artifact `${maven.build.repository.url}/${groupId}/${artifactId}/${version}` where the `.` of `${groupId}` are replaced by `/` | +| `maven.build.repository.id` | string | ID of the Maven repository to which the artifact is deployed. See [Maven POM reference / Repository](https://maven.apache.org/pom.html#Repository) | +| `maven.build.repository.url` | string | URL of the Maven repository to which the artifact is deployed. See [Maven POM reference / Repository](https://maven.apache.org/pom.html#Repository) | +| `peer.service` | string | Maven repository hostname deduced from the Repository URL | The `span.kind` is set to `client` ### `jib:build` -| Span attribute | Type | Description | -|-------------------------------------------------|----------|------------------------------------------------------------------------------------------------------------| -| `http.method` | string | `POST` | -| `http.url` | string | URL on the Docker registry deduced from the Docker image specified in the `build` goal configuration. | -| `maven.build.container.image.name` | string | Name of the produced Docker image | -| `maven.build.container.image.tags` | string[] | Tags of the produced Docker image | -| `maven.build.container.registry.url` | string | URL of the container registry to which this image is uploaded. | -| `peer.service` | string | Docker Registry hostname. | +| Span attribute | Type | Description | +|-------------------------------------------------|----------|----------------------------------------------------------------------------------------------------------------------------| +| `http.method` | string | `POST` | +| `http.url` | string | URL on the Docker registry deduced from the Docker image specified in the `build` goal configuration. | +| `maven.build.container.image.name` | string | Name of the produced Docker image | +| `maven.build.container.image.tags` | string[] | Tags of the produced Docker image | +| `maven.build.container.registry.url` | string | URL of the container registry to which this image is uploaded. | +| `peer.service` | string | Docker Registry hostname. | The `span.kind` is set to `client` @@ -132,12 +132,12 @@ The `span.kind` is set to `client` See . -| Span attribute | Type | Description | -|----------------|--------|------------------------------------------------------------------------------------------------| -| `http.method` | string | `POST` | -| `http.url` | string | `https://snyk.io/api/v1/monitor/maven` the underlying Snyk API URL invoked by the Maven plugin.| -| `rpc.method` | string | `monitor`, the underlying Snyk CLI command invoked by the Maven plugin.| -| `peer.service` | string | `snyk.io` | +| Span attribute | Type | Description | +|----------------|--------|-------------------------------------------------------------------------------------------------------- -| +| `http.method` | string | `POST` | +| `http.url` | string | `https://snyk.io/api/v1/monitor/maven` the underlying Snyk API URL invoked by the Maven plugin. | +| `rpc.method` | string | `monitor`, the underlying Snyk CLI command invoked by the Maven plugin. | +| `peer.service` | string | `snyk.io` | The `span.kind` is set to `client`