From 193d2cf5f6e76cd1080f002a73eea73f18397090 Mon Sep 17 00:00:00 2001 From: Andrzej Stencel Date: Thu, 13 Apr 2023 23:54:24 +0200 Subject: [PATCH] docs: update collector version to v0.75.0 --- docs/best-practices.md | 4 ++-- docs/fips.md | 8 +++---- docs/installation.md | 16 ++++++------- docs/migration.md | 50 +++++++++++++++++++-------------------- docs/release.md | 22 ++++++++--------- docs/upstream-relation.md | 4 ++-- 6 files changed, 52 insertions(+), 52 deletions(-) diff --git a/docs/best-practices.md b/docs/best-practices.md index e3033da120..18866a6e04 100644 --- a/docs/best-practices.md +++ b/docs/best-practices.md @@ -24,7 +24,7 @@ batch: **NOTE**: when using [Sumo Logic exporter][sumologicexporter] and sending data that is **not** in otlp format, you can explicitly limit size of the requests in bytes using config option `max_request_body_size`. -[batchprocessor]: https://github.com/open-telemetry/opentelemetry-collector/tree/v0.74.0/processor/batchprocessor -[memorylimiterprocessor]: https://github.com/open-telemetry/opentelemetry-collector/tree/v0.74.0/processor/memorylimiterprocessor +[batchprocessor]: https://github.com/open-telemetry/opentelemetry-collector/tree/v0.75.0/processor/batchprocessor +[memorylimiterprocessor]: https://github.com/open-telemetry/opentelemetry-collector/tree/v0.75.0/processor/memorylimiterprocessor [filterprocessor]: https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/processor/filterprocessor [sumologicexporter]: ../pkg/exporter/sumologicexporter diff --git a/docs/fips.md b/docs/fips.md index 0ab7b220f4..5630847489 100644 --- a/docs/fips.md +++ b/docs/fips.md @@ -25,21 +25,21 @@ The binaries can be downloaded from OT release pages. They are distinguished fro otelcol-sumo-${VERSION}-fips-${OS}-${ARCH} ``` -For example: +For example: ### Docker images Docker images containing the binaries have their tag suffixed with `-fips`. For example, where the normal image for -version `0.74.0-sumo-0` is: +version `0.75.0-sumo-0` is: ```text -docker pull public.ecr.aws/sumologic/sumologic-otel-collector:0.74.0-sumo-0 +docker pull public.ecr.aws/sumologic/sumologic-otel-collector:0.75.0-sumo-0 ``` The FIPS-approved version would be: ```text -docker pull public.ecr.aws/sumologic/sumologic-otel-collector:0.74.0-sumo-0-fips +docker pull public.ecr.aws/sumologic/sumologic-otel-collector:0.75.0-sumo-0-fips ``` > **Note** diff --git a/docs/installation.md b/docs/installation.md index e81f3cb350..5f3e552615 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -75,7 +75,7 @@ The following arguments can be passed to the script: | `--skip-installation-token` | `k` | Skips requirement for installation token. This option do not disable default configuration creation. | no | | `--tag` | `t` | Sets tag for collector. This argument can be use multiple times. One per tag. | yes, in `key=value` format | | `--download-only` | `w` | Download new binary only and skip configuration part. | no | -| `--version` | `v` | Version of Sumo Logic Distribution for OpenTelemetry Collector to install. By defult it gets latest version. | yes, e.g. `0.74.0-sumo-0` | +| `--version` | `v` | Version of Sumo Logic Distribution for OpenTelemetry Collector to install. By defult it gets latest version. | yes, e.g. `0.75.0-sumo-0` | | `--skip-config` | `s` | Do not create default configuration | no | | `--skip-systemd` | `d` | Preserves from Systemd service installation. | no | | `--fips` | `f` | Install the FIPS-compliant binary. See [this document](fips.md) for more details. | no | @@ -100,7 +100,7 @@ Follow the steps for your platform below. 1. Download the release binary: ```bash - curl -sLo otelcol-sumo "https://github.com/SumoLogic/sumologic-otel-collector/releases/download/v0.74.0-sumo-0/otelcol-sumo-0.74.0-sumo-0-linux_amd64" + curl -sLo otelcol-sumo "https://github.com/SumoLogic/sumologic-otel-collector/releases/download/v0.75.0-sumo-0/otelcol-sumo-0.75.0-sumo-0-linux_amd64" ``` 1. Install the release binary in your `PATH`: @@ -133,7 +133,7 @@ Follow the steps for your platform below. 1. Download the release binary: ```bash - curl -sLo otelcol-sumo "https://github.com/SumoLogic/sumologic-otel-collector/releases/download/v0.74.0-sumo-0/otelcol-sumo-0.74.0-sumo-0-linux_arm64" + curl -sLo otelcol-sumo "https://github.com/SumoLogic/sumologic-otel-collector/releases/download/v0.75.0-sumo-0/otelcol-sumo-0.75.0-sumo-0-linux_arm64" ``` 1. Install the release binary in your `PATH`: @@ -166,7 +166,7 @@ Follow the steps for your platform below. 1. Download the release binary: ```bash - curl -sLo otelcol-sumo "https://github.com/SumoLogic/sumologic-otel-collector/releases/download/v0.74.0-sumo-0/otelcol-sumo-0.74.0-sumo-0-darwin_amd64" + curl -sLo otelcol-sumo "https://github.com/SumoLogic/sumologic-otel-collector/releases/download/v0.75.0-sumo-0/otelcol-sumo-0.75.0-sumo-0-darwin_amd64" ``` 1. Install the release binary in your `PATH`: @@ -199,7 +199,7 @@ Follow the steps for your platform below. 1. Download the release binary: ```bash - curl -sLo otelcol-sumo "https://github.com/SumoLogic/sumologic-otel-collector/releases/download/v0.74.0-sumo-0/otelcol-sumo-0.74.0-sumo-0-darwin_arm64" + curl -sLo otelcol-sumo "https://github.com/SumoLogic/sumologic-otel-collector/releases/download/v0.75.0-sumo-0/otelcol-sumo-0.75.0-sumo-0-darwin_arm64" ``` 1. Install the release binary in your `PATH`: @@ -357,7 +357,7 @@ repository. 1. Set the release version variable: ```bash - export RELEASE_VERSION=0.74.0-sumo-0 + export RELEASE_VERSION=0.75.0-sumo-0 ``` 1. Prepare the configuration according to [this](configuration.md) document and save it in `config.yaml`. @@ -439,7 +439,7 @@ To run opentelemetry collector as Systemd Service please apply following steps: 1. Create configuration: - - Get [recommended configuration](https://github.com/SumoLogic/sumologic-otel-collector/blob/v0.74.0-sumo-0/examples/sumologic.yaml) from Sumo Logic repository and save it as `/etc/otelcol-sumo/sumologic.yaml`. + - Get [recommended configuration](https://github.com/SumoLogic/sumologic-otel-collector/blob/v0.75.0-sumo-0/examples/sumologic.yaml) from Sumo Logic repository and save it as `/etc/otelcol-sumo/sumologic.yaml`. - Create your custom configuration in `/etc/otelcol-sumo/conf.d`, e.g. `/etc/otelcol-sumo/conf.d/common.yaml` > **IMPORTANT NOTE**: @@ -549,7 +549,7 @@ We recommend to keep install token in environmental variable for Systemd install SUMOLOGIC_INSTALLATION_TOKEN= ``` - We use `SUMOLOGIC_INSTALLATION_TOKEN` in example, as it will be autoamtically used by [recommended configuration](https://github.com/SumoLogic/sumologic-otel-collector/blob/v0.74.0-sumo-0/examples/sumologic.yaml) + We use `SUMOLOGIC_INSTALLATION_TOKEN` in example, as it will be autoamtically used by [recommended configuration](https://github.com/SumoLogic/sumologic-otel-collector/blob/v0.75.0-sumo-0/examples/sumologic.yaml) 1. Ensure that file has correct owner and permissions: diff --git a/docs/migration.md b/docs/migration.md index 9df66bea98..779415506a 100644 --- a/docs/migration.md +++ b/docs/migration.md @@ -440,12 +440,12 @@ receivers: start_at: beginning ## encoding is substitute for Installed Collector `Encoding`. ## List of supported encodings: - ## https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/v0.74.0/receiver/filelogreceiver + ## https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/v0.75.0/receiver/filelogreceiver encoding: utf-8 ## multiline is Opentelemetry Collector substitute for `Enable Multiline Processing`. ## As multiline detection behaves slightly different than in Installed Collector ## the following section in filelog documentation is recommended to read: - ## https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/v0.74.0/receiver/filelogreceiver#multiline-configuration + ## https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/v0.75.0/receiver/filelogreceiver#multiline-configuration multiline: ## line_start_pattern is substitute of `Boundary Regex`. line_start_pattern: ^\d{4} @@ -737,11 +737,11 @@ receivers: start_at: end operators: ## Extract timestamp into timestamp field using regex - ## rel: https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/v0.74.0/pkg/stanza/docs/operators/regex_parser.md + ## rel: https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/v0.75.0/pkg/stanza/docs/operators/regex_parser.md - type: regex_parser regex: (?P^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2},\d{3} (\+|\-)\d{4}) ## Parse timestamp from timestamp field - ## rel: https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/v0.74.0/pkg/stanza/docs/operators/time_parser.md + ## rel: https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/v0.75.0/pkg/stanza/docs/operators/time_parser.md timestamp: parse_from: attributes.timestamp ## Layout are substitute for Timestamp Format configuration @@ -913,7 +913,7 @@ receivers: listen_address: 0.0.0.0:514 ## Add network attributes ## `net.peer.name` is going to be used as processors.source.source_host - ## rel: https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/v0.74.0/receiver/tcplogreceiver#configuration + ## rel: https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/v0.75.0/receiver/tcplogreceiver#configuration add_attributes: true ## Use UDP receiver for UDP protocol udplog/first receiver: @@ -922,7 +922,7 @@ receivers: listen_address: 0.0.0.0:514 ## Add network attributes ## `net.peer.name` is going to be used as processors.source.source_host - ## rel: https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/v0.74.0/receiver/udplogreceiver#configuration + ## rel: https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/v0.75.0/receiver/udplogreceiver#configuration add_attributes: true processors: @@ -1114,11 +1114,11 @@ receivers: listen_address: 0.0.0.0:514 operators: ## Extract timestamp into timestamp field using regex - ## rel: https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/v0.74.0/pkg/stanza/docs/operators/regex_parser.md + ## rel: https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/v0.75.0/pkg/stanza/docs/operators/regex_parser.md - type: regex_parser regex: (?P^\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2},\d{3} (\+|\-)\d{4}) ## Parse timestamp from timestamp field - ## rel: https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/v0.74.0/pkg/stanza/docs/operators//time_parser.md + ## rel: https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/v0.75.0/pkg/stanza/docs/operators//time_parser.md timestamp: parse_from: attributes.timestamp ## Layout are substitute for Timestamp Format configuration @@ -1292,7 +1292,7 @@ receivers: ## A list of images for which corresponding containers won't be scraped. ## Strings, regexes and globs are supported, more information in the receiver's readme: - ## https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/v0.74.0/receiver/dockerstatsreceiver#configuration + ## https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/v0.75.0/receiver/dockerstatsreceiver#configuration excluded_images: ## Exclude particular image - docker.io/library/nginx:1.2 @@ -1312,7 +1312,7 @@ receivers: api_version: 1.22 ## Enable or disable particular metrics. - ## Full list of metrics with their default config is available at https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/v0.74.0/receiver/dockerstatsreceiver/documentation.md + ## Full list of metrics with their default config is available at https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/v0.75.0/receiver/dockerstatsreceiver/documentation.md metrics: container.cpu.usage.percpu: enabled: true @@ -1399,7 +1399,7 @@ receivers: docker_stats: ## A list of images for which corresponding containers won't be scraped. ## Strings, regexes and globs are supported, more information in the receiver's readme: - ## https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/v0.74.0/receiver/dockerstatsreceiver#configuration + ## https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/v0.75.0/receiver/dockerstatsreceiver#configuration excluded_images: ## Exclude particular image - docker.io/library/nginx:1.2 @@ -2496,15 +2496,15 @@ Remote Windows Performance Source is not supported by the OpenTelemetry Collecto Windows Active Directory Source is not supported by the OpenTelemetry Collector. -[resourceprocessor]: https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/v0.74.0/processor/resourceprocessor -[multiline]: https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/v0.74.0/receiver/filelogreceiver#multiline-configuration -[supported_encodings]: https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/v0.74.0/receiver/filelogreceiver#supported-encodings -[udplogreceiver]: https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/v0.74.0/receiver/udplogreceiver -[tcplogreceiver]: https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/v0.74.0/receiver/tcplogreceiver -[filelogreceiver]: https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/v0.74.0/receiver/filelogreceiver -[syslogreceiver]: https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/v0.74.0/receiver/syslogreceiver -[transformprocessor]: https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/v0.74.0/processor/transformprocessor -[filterprocessor]: https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/v0.74.0/processor/filterprocessor +[resourceprocessor]: https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/v0.75.0/processor/resourceprocessor +[multiline]: https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/v0.75.0/receiver/filelogreceiver#multiline-configuration +[supported_encodings]: https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/v0.75.0/receiver/filelogreceiver#supported-encodings +[udplogreceiver]: https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/v0.75.0/receiver/udplogreceiver +[tcplogreceiver]: https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/v0.75.0/receiver/tcplogreceiver +[filelogreceiver]: https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/v0.75.0/receiver/filelogreceiver +[syslogreceiver]: https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/v0.75.0/receiver/syslogreceiver +[transformprocessor]: https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/v0.75.0/processor/transformprocessor +[filterprocessor]: https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/v0.75.0/processor/filterprocessor [sumologicsyslog]: ../pkg/processor/sumologicsyslogprocessor/README.md [network-semantic-convention]: https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/trace/semantic_conventions/span-general.md#general-network-connection-attributes [sumologicextension]: ../pkg/extension/sumologicextension/README.md @@ -2526,11 +2526,11 @@ Windows Active Directory Source is not supported by the OpenTelemetry Collector. [telegraf-input-netstat]: https://github.com/SumoLogic/telegraf/tree/v1.24.3-sumo-4/plugins/inputs/netstat/README.md [telegraf-input-diskio]: https://github.com/SumoLogic/telegraf/tree/v1.24.3-sumo-4/plugins/inputs/diskio [telegraf-input-disk]: https://github.com/SumoLogic/telegraf/tree/v1.24.3-sumo-4/plugins/inputs/disk -[dockerstatsreceiver]: https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/v0.74.0/receiver/dockerstatsreceiver -[dockerstatsmetrics]: https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/v0.74.0/receiver/dockerstatsreceiver/documentation.md +[dockerstatsreceiver]: https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/v0.75.0/receiver/dockerstatsreceiver +[dockerstatsmetrics]: https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/v0.75.0/receiver/dockerstatsreceiver/documentation.md [sumologicschemaprocessor]: ../pkg/processor/sumologicschemaprocessor/README.md -[filterprocessor]: https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/v0.74.0/processor/filterprocessor -[transformprocessor]: https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/v0.74.0/processor/transformprocessor +[filterprocessor]: https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/v0.75.0/processor/filterprocessor +[transformprocessor]: https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/v0.75.0/processor/transformprocessor [mask-filter]: https://help.sumologic.com/docs/send-data/use-json-configure-sources/#example-mask-filter -[ottlfuncs]: https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/v0.74.0/pkg/ottl/ottlfuncs#functions +[ottlfuncs]: https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/v0.75.0/pkg/ottl/ottlfuncs#functions [forward-data]: https://help.sumologic.com/docs/manage/data-forwarding/installed-collectors/ diff --git a/docs/release.md b/docs/release.md index a40d63d5ef..7f8815221f 100644 --- a/docs/release.md +++ b/docs/release.md @@ -37,7 +37,7 @@ that for you as well as pushing tags for all the plugins in this repo so that they can be imported from other repositories. ```shell -export TAG=v0.74.0-sumo-0 +export TAG=v0.75.0-sumo-0 make add-tag push-tag ``` @@ -65,7 +65,7 @@ you might need to remove the created tags, perhaps change something, and create To delete the tags both locally and remotely, run the following commands: ```shell -export TAG=v0.74.0-sumo-0 +export TAG=v0.75.0-sumo-0 make delete-tag delete-remote-tag ``` @@ -110,7 +110,7 @@ Updating OT core involves: We currently do not maintain patches for upstream components. -Historical process can be taken from [v0.74.0-sumo-0][updating_patched] if needed. +Historical process can be taken from [v0.57.2-sumo-0][updating_patched] if needed. ### Updating OT distro @@ -255,7 +255,7 @@ make update-journalctl [circleci_approve]: ../images/circleci_approve_workflow.png [changelog]: ../CHANGELOG.md [upgrading]: ./upgrading.md -[journaldreceiver]: https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/v0.74.0/receiver/journaldreceiver +[journaldreceiver]: https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/v0.75.0/receiver/journaldreceiver [debian_versions]: https://hub.docker.com/_/debian/?tab=description [otelcol_components]: https://github.com/open-telemetry/opentelemetry-collector-releases/blob/main/distributions/otelcol/manifest.yaml [otelcol_contrib_components]: https://github.com/open-telemetry/opentelemetry-collector-releases/blob/main/distributions/otelcol-contrib/manifest.yaml @@ -264,10 +264,10 @@ make update-journalctl [#604]: https://github.com/SumoLogic/sumologic-otel-collector/pull/604/files [otc_release]: https://github.com/open-telemetry/opentelemetry-collector-contrib/releases [ot_release]: https://github.com/open-telemetry/opentelemetry-collector/releases -[updating_patched]: https://github.com/SumoLogic/sumologic-otel-collector/blob/v0.74.0-sumo-0/docs/release.md#updating-patched-processors -[windowseventlogreceiver]: https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/v0.74.0/receiver/windowseventlogreceiver -[logstransformprocessor]: https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/v0.74.0/processor/logstransformprocessor -[dbstorage]: https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/v0.74.0/extension/storage/dbstorage -[dockerobserver]: https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/v0.74.0/extension/observer/dockerobserver -[ecsobserver]: https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/v0.74.0/extension/observer/ecsobserver -[ecstaskobserver]: https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/v0.74.0/extension/observer/ecstaskobserver +[updating_patched]: https://github.com/SumoLogic/sumologic-otel-collector/blob/v0.57.2-sumo-0/docs/release.md#updating-patched-processors +[windowseventlogreceiver]: https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/v0.75.0/receiver/windowseventlogreceiver +[logstransformprocessor]: https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/v0.75.0/processor/logstransformprocessor +[dbstorage]: https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/v0.75.0/extension/storage/dbstorage +[dockerobserver]: https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/v0.75.0/extension/observer/dockerobserver +[ecsobserver]: https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/v0.75.0/extension/observer/ecsobserver +[ecstaskobserver]: https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/v0.75.0/extension/observer/ecstaskobserver diff --git a/docs/upstream-relation.md b/docs/upstream-relation.md index e4a92d6d13..bec2be6302 100644 --- a/docs/upstream-relation.md +++ b/docs/upstream-relation.md @@ -28,7 +28,7 @@ and to provide better customer support: ## Versioning policy We are using upstream OpenTelemetry Collector version numbers as the base for the Sumo Logic Distribution for OpenTelemetry Collector version numbers. -This means that Sumo Logic Distribution for OpenTelemetry Collector `v0.74.0-sumo-0` is based on `v0.74.0` +This means that Sumo Logic Distribution for OpenTelemetry Collector `v0.75.0-sumo-0` is based on `v0.75.0` of the OpenTelemetry Collector core and contrib packages. In order to prevent confusion we are going to add Sumo Logic specific features @@ -36,7 +36,7 @@ when updating the OpenTelemetry Collector version. The OpenTelemetry Collector is released every two weeks and we are releasing up to week after the date. In case of critical fixes in our code, we will provide version with the same base like OT Distro, -but changed suffix, e.g. `v0.74.0-sumo-0`. +but changed suffix, e.g. `v0.75.0-sumo-1`. ## Breaking changes policy