Skip to content

Commit f9641c6

Browse files
Merge branch 'main' into add-receivers-v130
2 parents 5967ab4 + d79d422 commit f9641c6

File tree

7 files changed

+157
-90
lines changed

7 files changed

+157
-90
lines changed

.github/workflows/update-docs.yml

Lines changed: 50 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,25 @@ jobs:
1717
steps:
1818
- name: Checkout repository
1919
uses: actions/checkout@v5
20+
with:
21+
fetch-depth: 0 # Fetch all history including tags
22+
23+
- name: Add upstream remote and fetch tags
24+
run: |
25+
git remote add upstream https://github.com/elastic/elastic-agent.git || true
26+
git fetch upstream --tags
27+
28+
- name: Find latest semantic version
29+
id: get_version
30+
run: |
31+
# Get the latest semantic version tag (excluding pre-release versions)
32+
LATEST_VERSION=$(git tag --list | grep -E "^v[0-9]+\.[0-9]+\.[0-9]+$" | sort -V | tail -1)
33+
echo "Latest version: $LATEST_VERSION"
34+
echo "version=$LATEST_VERSION" >> $GITHUB_OUTPUT
35+
36+
- name: Pass version to script
37+
run: |
38+
echo "LATEST_VERSION=${{ steps.get_version.outputs.version }}" >> $GITHUB_ENV
2039
2140
- name: Set up Python
2241
uses: actions/setup-python@v6
@@ -34,23 +53,49 @@ jobs:
3453
cd docs/scripts/update-docs
3554
python update-components-docs.py
3655
56+
- name: Check if branch already exists
57+
id: check_branch
58+
run: |
59+
BRANCH_NAME="update-docs-${{ steps.get_version.outputs.version }}"
60+
if git ls-remote --heads origin "$BRANCH_NAME" | grep -q "$BRANCH_NAME"; then
61+
echo "Branch $BRANCH_NAME already exists. Documentation for this version has already been updated."
62+
echo "branch_exists=true" >> $GITHUB_OUTPUT
63+
else
64+
echo "Branch $BRANCH_NAME does not exist. Proceeding with PR creation."
65+
echo "branch_exists=false" >> $GITHUB_OUTPUT
66+
fi
67+
3768
- name: Create Pull Request
69+
if: steps.check_branch.outputs.branch_exists == 'false'
3870
uses: peter-evans/create-pull-request@271a8d0340265f705b14b6d32b9829c1cb33d45e # v7.0.8
3971
with:
4072
token: ${{ secrets.GITHUB_TOKEN }}
41-
commit-message: "docs: update generated documentation"
42-
title: "Update generated documentation"
73+
commit-message: "docs: update generated documentation for ${{ steps.get_version.outputs.version }}"
74+
title: "Update generated documentation for ${{ steps.get_version.outputs.version }}"
4375
body: |
44-
This PR updates the generated documentation based on the latest local repository data.
76+
This PR updates the generated documentation based on the latest released version **${{ steps.get_version.outputs.version }}**.
4577
78+
## Changes
4679
- Updates EDOT Collector component tables
4780
- Updates OpenTelemetry Collector Builder (OCB) configuration
48-
- Uses local version from version.go file
81+
- Uses data from the latest released version tag: `${{ steps.get_version.outputs.version }}`
82+
83+
## References
84+
- **Source go.mod**: https://github.com/elastic/elastic-agent/blob/${{ steps.get_version.outputs.version }}/go.mod
85+
- **Source core-components.yaml**: https://github.com/elastic/elastic-agent/blob/${{ steps.get_version.outputs.version }}/internal/pkg/otel/core-components.yaml
86+
- **Release tag**: https://github.com/elastic/elastic-agent/tree/${{ steps.get_version.outputs.version }}
4987
5088
This is an automated PR created by the documentation update workflow.
51-
branch: update-docs
89+
branch: update-docs-${{ steps.get_version.outputs.version }}
5290
base: main
5391
delete-branch: true
5492
labels: |
5593
documentation
5694
automated-pr
95+
96+
- name: Skip PR creation (branch exists)
97+
if: steps.check_branch.outputs.branch_exists == 'true'
98+
run: |
99+
echo "✅ Documentation for version ${{ steps.get_version.outputs.version }} has already been updated."
100+
echo "Branch update-docs-${{ steps.get_version.outputs.version }} already exists."
101+
echo "Workflow completed successfully - no action needed."

docs/reference/edot-collector/components.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -21,11 +21,14 @@ The {{edot}} (EDOT) Collector includes embedded Collector components from the [O
2121
The components included in the EDOT Collector are categorized into **[Core]** and **[Extended]** components. The following table describes the current components included in the EDOT Collector, their source, and support status.
2222

2323
% start:edot-collector-components-table
24+
## List of components
25+
26+
These components are included in EDOT Collector version 9.1.4.
27+
2428
| Component | GitHub Repo | Support status | Version |
2529
|:---|:---|:---|:---|
2630
|***Receivers***||||
2731
| [dockerstatsreceiver ](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/dockerstatsreceiver) | [OTel Contrib Repo](https://github.com/open-telemetry/opentelemetry-collector-contrib) | [Extended] | v0.130.0 |
28-
| [elasticapmintakereceiver ](/reference/edot-collector/components/elasticapmintakereceiver.md) | [Elastic Repo](https://github.com/elastic/opentelemetry-collector-components) | [Core] | v0.2.1 |
2932
| [filelogreceiver ](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/filelogreceiver) | [OTel Contrib Repo](https://github.com/open-telemetry/opentelemetry-collector-contrib) | [Core] | v0.130.0 |
3033
| [hostmetricsreceiver ](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/hostmetricsreceiver) | [OTel Contrib Repo](https://github.com/open-telemetry/opentelemetry-collector-contrib) | [Core] | v0.130.0 |
3134
| [httpcheckreceiver ](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/httpcheckreceiver) | [OTel Contrib Repo](https://github.com/open-telemetry/opentelemetry-collector-contrib) | [Extended] | v0.130.0 |
@@ -43,8 +46,8 @@ The components included in the EDOT Collector are categorized into **[Core]** an
4346
| [redisreceiver ](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/redisreceiver) | [OTel Contrib Repo](https://github.com/open-telemetry/opentelemetry-collector-contrib) | [Extended] | v0.130.0 |
4447
| [zipkinreceiver ](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/receiver/zipkinreceiver) | [OTel Contrib Repo](https://github.com/open-telemetry/opentelemetry-collector-contrib) | [Extended] | v0.130.0 |
4548
|***Exporters***||||
46-
| [debugexporter ](https://github.com/open-telemetry/opentelemetry-collector/tree/main/exporter/debugexporter) | [OTel Core Repo](https://github.com/open-telemetry/opentelemetry-collector) | [Extended] | v0.132.0 |
47-
| [elasticsearchexporter ](/reference/edot-collector/components/elasticsearchexporter.md) | [OTel Contrib Repo](https://github.com/open-telemetry/opentelemetry-collector-contrib) | [Core] | v0.132.0 |
49+
| [debugexporter ](https://github.com/open-telemetry/opentelemetry-collector/tree/main/exporter/debugexporter) | [OTel Core Repo](https://github.com/open-telemetry/opentelemetry-collector) | [Extended] | v0.130.0 |
50+
| [elasticsearchexporter ](/reference/edot-collector/components/elasticsearchexporter.md) | [OTel Contrib Repo](https://github.com/open-telemetry/opentelemetry-collector-contrib) | [Core] | v0.130.0 |
4851
| [fileexporter ](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/exporter/fileexporter) | [OTel Contrib Repo](https://github.com/open-telemetry/opentelemetry-collector-contrib) | [Extended] | v0.130.0 |
4952
| [kafkaexporter ](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/exporter/kafkaexporter) | [OTel Contrib Repo](https://github.com/open-telemetry/opentelemetry-collector-contrib) | [Extended] | v0.130.0 |
5053
| [loadbalancingexporter ](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/exporter/loadbalancingexporter) | [OTel Contrib Repo](https://github.com/open-telemetry/opentelemetry-collector-contrib) | [Extended] | v0.130.0 |
@@ -63,7 +66,6 @@ The components included in the EDOT Collector are categorized into **[Core]** an
6366
| [memorylimiterprocessor ](https://github.com/open-telemetry/opentelemetry-collector/tree/main/processor/memorylimiterprocessor) | [OTel Core Repo](https://github.com/open-telemetry/opentelemetry-collector) | [Extended] | v0.130.0 |
6467
| [resourcedetectionprocessor ](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/processor/resourcedetectionprocessor) | [OTel Contrib Repo](https://github.com/open-telemetry/opentelemetry-collector-contrib) | [Core] | v0.130.0 |
6568
| [resourceprocessor ](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/processor/resourceprocessor) | [OTel Contrib Repo](https://github.com/open-telemetry/opentelemetry-collector-contrib) | [Core] | v0.130.0 |
66-
| [tailsamplingprocessor ](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/processor/tailsamplingprocessor) | [OTel Contrib Repo](https://github.com/open-telemetry/opentelemetry-collector-contrib) | [Extended] | v0.130.0 |
6769
| [transformprocessor ](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/processor/transformprocessor) | [OTel Contrib Repo](https://github.com/open-telemetry/opentelemetry-collector-contrib) | [Core] | v0.130.0 |
6870
|***Connectors***||||
6971
| [elasticapmconnector ](https://github.com/elastic/opentelemetry-collector-components/tree/main/connector/elasticapmconnector) | [Elastic Repo](https://github.com/elastic/opentelemetry-collector-components) | [Core] | v0.6.0 |
@@ -76,17 +78,16 @@ The components included in the EDOT Collector are categorized into **[Core]** an
7678
| [bearertokenauthextension ](/reference/edot-collector/config/authentication-methods.md) | [OTel Contrib Repo](https://github.com/open-telemetry/opentelemetry-collector-contrib) | [Extended] | v0.130.0 |
7779
| [filestorage ](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/extension/storage/filestorage) | [OTel Contrib Repo](https://github.com/open-telemetry/opentelemetry-collector-contrib) | [Core] | v0.130.0 |
7880
| [healthcheckextension ](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/extension/healthcheckextension) | [OTel Contrib Repo](https://github.com/open-telemetry/opentelemetry-collector-contrib) | [Extended] | v0.130.0 |
79-
| [healthcheckv2extension ](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/extension/healthcheckv2extension) | [OTel Contrib Repo](https://github.com/open-telemetry/opentelemetry-collector-contrib) | [Extended] | v0.130.0 |
8081
| [k8sleaderelector ](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/extension/k8sleaderelector) | [OTel Contrib Repo](https://github.com/open-telemetry/opentelemetry-collector-contrib) | [Extended] | v0.130.0 |
8182
| [k8sobserver ](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/extension/observer/k8sobserver) | [OTel Contrib Repo](https://github.com/open-telemetry/opentelemetry-collector-contrib) | [Extended] | v0.130.0 |
8283
| [memorylimiterextension ](https://github.com/open-telemetry/opentelemetry-collector/tree/main/extension/memorylimiterextension) | [OTel Core Repo](https://github.com/open-telemetry/opentelemetry-collector) | [Extended] | v0.130.0 |
8384
| [pprofextension ](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/extension/pprofextension) | [OTel Contrib Repo](https://github.com/open-telemetry/opentelemetry-collector-contrib) | [Extended] | v0.130.0 |
8485
|***Providers***||||
8586
| [envprovider ](https://github.com/open-telemetry/opentelemetry-collector/tree/main/confmap/provider/envprovider) | [OTel Core Repo](https://github.com/open-telemetry/opentelemetry-collector) | [Core] | v1.36.0 |
86-
| [fileprovider ](https://github.com/open-telemetry/opentelemetry-collector/tree/main/confmap/provider/fileprovider) | [OTel Core Repo](https://github.com/open-telemetry/opentelemetry-collector) | [Core] | v1.38.0 |
87+
| [fileprovider ](https://github.com/open-telemetry/opentelemetry-collector/tree/main/confmap/provider/fileprovider) | [OTel Core Repo](https://github.com/open-telemetry/opentelemetry-collector) | [Core] | v1.36.0 |
8788
| [httpprovider ](https://github.com/open-telemetry/opentelemetry-collector/tree/main/confmap/provider/httpprovider) | [OTel Core Repo](https://github.com/open-telemetry/opentelemetry-collector) | [Core] | v1.36.0 |
88-
| [httpsprovider ](https://github.com/open-telemetry/opentelemetry-collector/tree/main/confmap/provider/httpsprovider) | [OTel Core Repo](https://github.com/open-telemetry/opentelemetry-collector) | [Core] | v1.35.0 |
89-
| [yamlprovider ](https://github.com/open-telemetry/opentelemetry-collector/tree/main/confmap/provider/yamlprovider) | [OTel Core Repo](https://github.com/open-telemetry/opentelemetry-collector) | [Core] | v1.38.0 |
89+
| [httpsprovider ](https://github.com/open-telemetry/opentelemetry-collector/tree/main/confmap/provider/httpsprovider) | [OTel Core Repo](https://github.com/open-telemetry/opentelemetry-collector) | [Core] | v1.36.0 |
90+
| [yamlprovider ](https://github.com/open-telemetry/opentelemetry-collector/tree/main/confmap/provider/yamlprovider) | [OTel Core Repo](https://github.com/open-telemetry/opentelemetry-collector) | [Core] | v1.36.0 |
9091

9192
% end:edot-collector-components-table
9293

docs/reference/edot-collector/custom-collector.md

Lines changed: 7 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,8 @@ Create a builder configuration file,`builder-config.yml`, to define the custom C
4444
The following example, `builder-config.yml`, contains the components needed to send your telemetry data to Elastic Observability. For more information on these components, refer to the [components](/reference/edot-collector/components.md) documentation. Keep or remove components from the example configuration file to fit your needs.
4545

4646
% start:edot-collector-components-ocb
47+
This OCB configuration is for EDOT Collector version 9.1.4.
48+
4749
```yaml
4850
dist:
4951
otelcol_edot:
@@ -66,8 +68,6 @@ dist:
6668
receivers:
6769
dockerstatsreceiver :
6870
gomod: github.com/open-telemetry/opentelemetry-collector-contrib/receiver/dockerstatsreceiver v0.130.0
69-
elasticapmintakereceiver :
70-
gomod: github.com/elastic/opentelemetry-collector-components/receiver/elasticapmintakereceiver v0.2.1
7171
filelogreceiver :
7272
gomod: github.com/open-telemetry/opentelemetry-collector-contrib/receiver/filelogreceiver v0.130.0
7373
hostmetricsreceiver :
@@ -124,16 +124,14 @@ processors:
124124
gomod: github.com/open-telemetry/opentelemetry-collector-contrib/processor/resourcedetectionprocessor v0.130.0
125125
resourceprocessor :
126126
gomod: github.com/open-telemetry/opentelemetry-collector-contrib/processor/resourceprocessor v0.130.0
127-
tailsamplingprocessor :
128-
gomod: github.com/open-telemetry/opentelemetry-collector-contrib/processor/tailsamplingprocessor v0.130.0
129127
transformprocessor :
130128
gomod: github.com/open-telemetry/opentelemetry-collector-contrib/processor/transformprocessor v0.130.0
131129

132130
exporters:
133131
debugexporter :
134-
gomod: go.opentelemetry.io/collector/exporter/debugexporter v0.132.0
132+
gomod: go.opentelemetry.io/collector/exporter/debugexporter v0.130.0
135133
elasticsearchexporter :
136-
gomod: github.com/open-telemetry/opentelemetry-collector-contrib/exporter/elasticsearchexporter v0.132.0
134+
gomod: github.com/open-telemetry/opentelemetry-collector-contrib/exporter/elasticsearchexporter v0.130.0
137135
fileexporter :
138136
gomod: github.com/open-telemetry/opentelemetry-collector-contrib/exporter/fileexporter v0.130.0
139137
kafkaexporter :
@@ -168,8 +166,6 @@ extensions:
168166
gomod: github.com/open-telemetry/opentelemetry-collector-contrib/extension/storage/filestorage v0.130.0
169167
healthcheckextension :
170168
gomod: github.com/open-telemetry/opentelemetry-collector-contrib/extension/healthcheckextension v0.130.0
171-
healthcheckv2extension :
172-
gomod: github.com/open-telemetry/opentelemetry-collector-contrib/extension/healthcheckv2extension v0.130.0
173169
k8sleaderelector :
174170
gomod: github.com/open-telemetry/opentelemetry-collector-contrib/extension/k8sleaderelector v0.130.0
175171
k8sobserver :
@@ -183,13 +179,13 @@ providers:
183179
envprovider :
184180
gomod: go.opentelemetry.io/collector/confmap/provider/envprovider v1.36.0
185181
fileprovider :
186-
gomod: go.opentelemetry.io/collector/confmap/provider/fileprovider v1.38.0
182+
gomod: go.opentelemetry.io/collector/confmap/provider/fileprovider v1.36.0
187183
httpprovider :
188184
gomod: go.opentelemetry.io/collector/confmap/provider/httpprovider v1.36.0
189185
httpsprovider :
190-
gomod: go.opentelemetry.io/collector/confmap/provider/httpsprovider v1.35.0
186+
gomod: go.opentelemetry.io/collector/confmap/provider/httpsprovider v1.36.0
191187
yamlprovider :
192-
gomod: go.opentelemetry.io/collector/confmap/provider/yamlprovider v1.38.0
188+
gomod: go.opentelemetry.io/collector/confmap/provider/yamlprovider v1.36.0
193189
```
194190
% end:edot-collector-components-ocb
195191

docs/reference/edot-collector/download.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,3 +38,7 @@ sudo ./otelcol --config otel.yml
3838
```
3939

4040
For specific configuration, refer to the [Quickstart guides](docs-content://solutions/observability/get-started/opentelemetry/quickstart/index.md) or refer to [Configuration](/reference/edot-collector/config/index.md).
41+
42+
:::{tip}
43+
To download a specific version of the EDOT Collector, replace {{version.edot_collector}} with the version you want to download.
44+
:::

docs/scripts/update-docs/templates/components-table.jinja2

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
## List of components
2+
3+
These components are included in EDOT Collector version {{version.edot_collector}}.
4+
15
| Component | GitHub Repo | Support status | Version |
26
|:---|:---|:---|:---|
37
{%if grouped_components['Receivers'] -%}

docs/scripts/update-docs/templates/ocb.jinja2

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
This OCB configuration is for EDOT Collector version {{version.edot_collector}}.
2+
13
```yaml
24
dist:
35
otelcol_edot:

0 commit comments

Comments
 (0)