Skip to content

Commit

Permalink
docs: make deprecation of classic modules more clear (#6709)
Browse files Browse the repository at this point in the history
The deprecation status of classic modules was constrained to the concept
page of modules. This commit adds the deprecation notice to each
component reference page and mentions it in the release notes.

Co-authored-by: Clayton Cornell <[email protected]>
  • Loading branch information
rfratto and clayton-cornell authored Mar 15, 2024
1 parent 4b5ba6f commit 9d65d9f
Show file tree
Hide file tree
Showing 5 changed files with 34 additions and 4 deletions.
7 changes: 6 additions & 1 deletion docs/sources/flow/reference/components/module.file.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,12 @@ labels:
title: module.file
---

# module.file
# module.file (deprecated)

{{< admonition type="caution" >}}
Starting with release v0.40, `module.string` is deprecated and is replaced by `import.string`.
`module.string` will be removed in a future release.
{{< /admonition >}}

{{< docs/shared lookup="flow/stability/beta.md" source="agent" version="<AGENT_VERSION>" >}}

Expand Down
7 changes: 6 additions & 1 deletion docs/sources/flow/reference/components/module.git.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,12 @@ labels:
title: module.git
---

# module.git
# module.git (deprecated)

{{< admonition type="caution" >}}
Starting with release v0.40, `module.git` is deprecated and is replaced by `import.git`.
`module.git` will be removed in a future release.
{{< /admonition >}}

{{< docs/shared lookup="flow/stability/beta.md" source="agent" version="<AGENT_VERSION>" >}}

Expand Down
7 changes: 6 additions & 1 deletion docs/sources/flow/reference/components/module.http.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,12 @@ labels:
title: module.http
---

# module.http
# module.http (deprecated)

{{< admonition type="caution" >}}
Starting with release v0.40, `module.http` is deprecated and is replaced by `import.http`.
`module.http` will be removed in a future release.
{{< /admonition >}}

{{< docs/shared lookup="flow/stability/beta.md" source="agent" version="<AGENT_VERSION>" >}}

Expand Down
7 changes: 6 additions & 1 deletion docs/sources/flow/reference/components/module.string.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,12 @@ labels:
title: module.string
---

# module.string
# module.string (deprecated)

{{< admonition type="caution" >}}
Starting with release v0.40, `module.string` is deprecated and is replaced by `import.string`.
`module.string` will be removed in a future release.
{{< /admonition >}}

{{< docs/shared lookup="flow/stability/beta.md" source="agent" version="<AGENT_VERSION>" >}}

Expand Down
10 changes: 10 additions & 0 deletions docs/sources/flow/release-notes.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,10 @@ Other release notes for the different {{< param "PRODUCT_ROOT_NAME" >}} variants
The default listen port for `otelcol.receiver.opencensus` has changed from 4317 to 55678 to align with the upstream defaults.
To retain the previous listen port, explicitly set the `endpoint` argument to `0.0.0.0:4317` before upgrading.

### Breaking change: classic modules have been removed

Classic modules (the `module.git`, `module.file`, `module.http`, and `module.string` components) were initially deprecated in v0.40 in favor of the `import` and `declare` configuration blocks, and have been removed as of this release.

## v0.40

### Breaking change: Prohibit the configuration of services within modules.
Expand All @@ -53,6 +57,12 @@ If you need to see high cardinality metrics containing labels such as IP address
The name `prometheus.exporter.agent` is potentially ambiguous and can be misinterpreted as an exporter for Prometheus Agent.
The new name reflects the component's true purpose as an exporter of the process's own metrics.

### Deprecation: classic modules have been deprecated and will be removed in the next release

Classic modules (the `module.git`, `module.file`, `module.http`, and `module.string` components) have been deprecated in favor of the new `import` and `declare` configuration blocks.

Support for classic modules will be removed in the next release.

## v0.39

### Breaking change: `otelcol.receiver.prometheus` will drop all `otel_scope_info` metrics when converting them to OTLP
Expand Down

0 comments on commit 9d65d9f

Please sign in to comment.