Switch link checker to lychee (#6972)
This commit is contained in:
parent
717d8b0032
commit
abdbf07dfd
|
@ -1,7 +0,0 @@
|
||||||
{
|
|
||||||
"retryOn429": true,
|
|
||||||
"aliveStatusCodes": [
|
|
||||||
200,
|
|
||||||
403
|
|
||||||
]
|
|
||||||
}
|
|
|
@ -1,17 +0,0 @@
|
||||||
#!/bin/bash -e
|
|
||||||
|
|
||||||
# this script helps to reduce sporadic link check failures by retrying at a file-by-file level
|
|
||||||
|
|
||||||
retry_count=3
|
|
||||||
|
|
||||||
for file in "$@"; do
|
|
||||||
for i in $(seq 1 $retry_count); do
|
|
||||||
if markdown-link-check --config "$(dirname "$0")/../config/markdown-link-check-config.json" \
|
|
||||||
"$file"; then
|
|
||||||
break
|
|
||||||
elif [[ $i -eq $retry_count ]]; then
|
|
||||||
exit 1
|
|
||||||
fi
|
|
||||||
sleep 5
|
|
||||||
done
|
|
||||||
done
|
|
|
@ -9,13 +9,13 @@ jobs:
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@v4
|
||||||
|
|
||||||
- name: Install markdown-link-check
|
- uses: lycheeverse/lychee-action@v2
|
||||||
# TODO(jack-berg): use latest when config file reading bug is fixed: https://github.com/tcort/markdown-link-check/issues/246
|
with:
|
||||||
run: npm install -g markdown-link-check@3.10.3
|
# remove version after next release of lychee-action
|
||||||
|
lycheeVersion: latest
|
||||||
- name: Run markdown-link-check
|
# excluding links to pull requests and issues is done for performance
|
||||||
run: |
|
args: >
|
||||||
find . -type f \
|
--include-fragments
|
||||||
-name '*.md' \
|
--exclude "^https://github.com/open-telemetry/opentelemetry-java/(issue|pull)/\\d+$"
|
||||||
-not -path './CHANGELOG.md' \
|
--max-retries 6
|
||||||
| xargs .github/scripts/markdown-link-check-with-retry.sh
|
.
|
||||||
|
|
18
CHANGELOG.md
18
CHANGELOG.md
|
@ -521,7 +521,7 @@
|
||||||
have stopped being published. Jaeger
|
have stopped being published. Jaeger
|
||||||
has [native support for OTLP](https://opentelemetry.io/blog/2022/jaeger-native-otlp/), and users
|
has [native support for OTLP](https://opentelemetry.io/blog/2022/jaeger-native-otlp/), and users
|
||||||
should export to jaeger
|
should export to jaeger
|
||||||
using [OTLP](https://opentelemetry.io/docs/instrumentation/java/exporters/#otlp-dependencies)
|
using OTLP
|
||||||
instead.
|
instead.
|
||||||
|
|
||||||
### API
|
### API
|
||||||
|
@ -605,7 +605,7 @@ instead.
|
||||||
and `opentelemetry-exporter-jaeger-thift`. Jaeger
|
and `opentelemetry-exporter-jaeger-thift`. Jaeger
|
||||||
has [native support for OTLP](https://opentelemetry.io/blog/2022/jaeger-native-otlp/), and users
|
has [native support for OTLP](https://opentelemetry.io/blog/2022/jaeger-native-otlp/), and users
|
||||||
should export to jaeger
|
should export to jaeger
|
||||||
using [OTLP](https://opentelemetry.io/docs/instrumentation/java/exporters/#otlp-dependencies)
|
using OTLP
|
||||||
instead.
|
instead.
|
||||||
|
|
||||||
### API
|
### API
|
||||||
|
@ -1042,7 +1042,7 @@ The log bridge API / SDK are now stable! Some important notes:
|
||||||
of `otel.logs.exporter` from `none` to `otlp`.
|
of `otel.logs.exporter` from `none` to `otlp`.
|
||||||
|
|
||||||
NOTE: reminder that
|
NOTE: reminder that
|
||||||
the [Logs Bridge API](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/logs/bridge-api.md)
|
the [Logs Bridge API](https://github.com/open-telemetry/opentelemetry-specification/blob/v1.21.0/specification/logs/bridge-api.md)
|
||||||
is _not_ meant for end users. Log appenders use the API to bridge logs from existing log
|
is _not_ meant for end users. Log appenders use the API to bridge logs from existing log
|
||||||
frameworks (e.g. JUL, Log4j, SLf4J, Logback) into OpenTelemetry. Users configure the Log SDK to
|
frameworks (e.g. JUL, Log4j, SLf4J, Logback) into OpenTelemetry. Users configure the Log SDK to
|
||||||
dictate how logs are processed and exported.
|
dictate how logs are processed and exported.
|
||||||
|
@ -1110,7 +1110,7 @@ merged into `opentelemetry-exporter-otlp`, `opentelemetry-sdk-logs-testing` will
|
||||||
into `opentelemetry-sdk-testing`, `opentelemetry-sdk-extension-autoconfigure` will enable `otlp`
|
into `opentelemetry-sdk-testing`, `opentelemetry-sdk-extension-autoconfigure` will enable `otlp`
|
||||||
log exporter by default (i.e. `otel.logs.exporter=otlp`). For more details, see tracking
|
log exporter by default (i.e. `otel.logs.exporter=otlp`). For more details, see tracking
|
||||||
issue [#5340](https://github.com/open-telemetry/opentelemetry-java/issues/5340). NOTE: reminder that
|
issue [#5340](https://github.com/open-telemetry/opentelemetry-java/issues/5340). NOTE: reminder that
|
||||||
the [Logs Bridge API](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/logs/bridge-api.md)
|
the [Logs Bridge API](https://github.com/open-telemetry/opentelemetry-specification/blob/v1.21.0/specification/logs/bridge-api.md)
|
||||||
is _not_ meant for end users. Log appenders use the API to bridge logs from existing log
|
is _not_ meant for end users. Log appenders use the API to bridge logs from existing log
|
||||||
frameworks (e.g. JUL, Log4j, SLf4J, Logback) into OpenTelemetry. Users configure the Log SDK to
|
frameworks (e.g. JUL, Log4j, SLf4J, Logback) into OpenTelemetry. Users configure the Log SDK to
|
||||||
dictate how logs are processed and exported.
|
dictate how logs are processed and exported.
|
||||||
|
@ -1672,8 +1672,8 @@ log API component has been added for emitting events and for writing log appende
|
||||||
API is not a substitute for traditional log frameworks like Log4j, JUL, SLF4J, or Logback. While the
|
API is not a substitute for traditional log frameworks like Log4j, JUL, SLF4J, or Logback. While the
|
||||||
event portion of the API is intended for instrumentation authors and end users, the API for emitting
|
event portion of the API is intended for instrumentation authors and end users, the API for emitting
|
||||||
LogRecords is not.
|
LogRecords is not.
|
||||||
See [LoggerProvider](./api/logs/src/main/java/io/opentelemetry/api/logs/LoggerProvider.java)
|
See [LoggerProvider](./api/all/src/main/java/io/opentelemetry/api/logs/LoggerProvider.java)
|
||||||
and [Logger](./api/logs/src/main/java/io/opentelemetry/api/logs/Logger.java) javadoc for more
|
and [Logger](./api/all/src/main/java/io/opentelemetry/api/logs/Logger.java) javadoc for more
|
||||||
details.
|
details.
|
||||||
|
|
||||||
### General
|
### General
|
||||||
|
@ -1959,7 +1959,7 @@ details.
|
||||||
stable `opentelemetry-sdk-extension-autoconfigure-spi`.
|
stable `opentelemetry-sdk-extension-autoconfigure-spi`.
|
||||||
* Autoconfigure now supports multiple values for `otel.metrics.exporter`.
|
* Autoconfigure now supports multiple values for `otel.metrics.exporter`.
|
||||||
* Autoconfigure now
|
* Autoconfigure now
|
||||||
supports [general attribute limits](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/sdk-environment-variables.md#attribute-limits),
|
supports [general attribute limits](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/configuration/sdk-environment-variables.md#attribute-limits),
|
||||||
applicable to span attributes, span event attributes, span link attributes, and log attributes.
|
applicable to span attributes, span event attributes, span link attributes, and log attributes.
|
||||||
* Autoconfigure now supports an experimental option to disable the SDK.
|
* Autoconfigure now supports an experimental option to disable the SDK.
|
||||||
If `otel.experimental.sdk.enabled=true`, `AutoConfiguredOpenTelemetrySdk#getOpenTelemetrySdk()`
|
If `otel.experimental.sdk.enabled=true`, `AutoConfiguredOpenTelemetrySdk#getOpenTelemetrySdk()`
|
||||||
|
@ -3519,7 +3519,7 @@ See the `opentelemetry-extension-kotlin` module for details.
|
||||||
|
|
||||||
#### Breaking changes
|
#### Breaking changes
|
||||||
|
|
||||||
- There have been many updates to the semantic conventions constants. The constants are now auto-generated from the YAML specification files, so the names will now be consistent across languages. For more information, see the [YAML Model for Semantic Conventions](https://github.com/open-telemetry/opentelemetry-specification/tree/master/semantic_conventions).
|
- There have been many updates to the semantic conventions constants. The constants are now auto-generated from the YAML specification files, so the names will now be consistent across languages. For more information, see the [YAML Model for Semantic Conventions](https://github.com/open-telemetry/semantic-conventions/tree/main/model#yaml-model-for-semantic-conventions).
|
||||||
- All API classes have been moved into the `io.opentelemetry.api.` prefix to support JPMS users.
|
- All API classes have been moved into the `io.opentelemetry.api.` prefix to support JPMS users.
|
||||||
- The API no longer uses the `grpc-context` as the context implementation. It now uses `io.opentelemetry.context.Context`. This is published in the `opentelemetry-context` artifact. Interactions with the context were mostly moved to static methods in the `Span` and `Baggage` interfaces.
|
- The API no longer uses the `grpc-context` as the context implementation. It now uses `io.opentelemetry.context.Context`. This is published in the `opentelemetry-context` artifact. Interactions with the context were mostly moved to static methods in the `Span` and `Baggage` interfaces.
|
||||||
- The Baggage API has been reworked to more closely match the specification. This includes the removal of the `BaggageManager`. Baggage is fully functional within the API, without needing to install an SDK.
|
- The Baggage API has been reworked to more closely match the specification. This includes the removal of the `BaggageManager`. Baggage is fully functional within the API, without needing to install an SDK.
|
||||||
|
@ -3550,7 +3550,7 @@ See the `opentelemetry-extension-kotlin` module for details.
|
||||||
|
|
||||||
#### Breaking changes
|
#### Breaking changes
|
||||||
|
|
||||||
- `TraceConfig` configuration option names (environment variables and system properties) were renamed to match the OpenTelemetery Specification. For more information, see [TraceConfig](./QUICKSTART.md#TraceConfig).
|
- `TraceConfig` configuration option names (environment variables and system properties) were renamed to match the OpenTelemetery Specification.
|
||||||
- The Jaeger gRPC exporter was updated to match the OpenTelemetry Specification. The `message` log entry attribute has been renamed to `event` and a new `dropped attributes count` attribute was added. For more information, see the [Overview](https://github.com/open-telemetry/opentelemetry-specification/blob/master/specification/overview.md).
|
- The Jaeger gRPC exporter was updated to match the OpenTelemetry Specification. The `message` log entry attribute has been renamed to `event` and a new `dropped attributes count` attribute was added. For more information, see the [Overview](https://github.com/open-telemetry/opentelemetry-specification/blob/master/specification/overview.md).
|
||||||
- The `SpanData.getHasRemoteParent()` and `SpanData.getHasEnded()` methods were renamed to `hasRemoteParent()` and `hasEnded()`, respectively.
|
- The `SpanData.getHasRemoteParent()` and `SpanData.getHasEnded()` methods were renamed to `hasRemoteParent()` and `hasEnded()`, respectively.
|
||||||
- The `IdsGenerator` interface has been renamed to `IdGenerator`, and all implementations and relevant factory methods were similarly renamed.
|
- The `IdsGenerator` interface has been renamed to `IdGenerator`, and all implementations and relevant factory methods were similarly renamed.
|
||||||
|
|
Loading…
Reference in New Issue