Skip to content

Commit e17d861

Browse files
theletterfcolleenmcginnisv1v
authored
Add Collector reference docs and automation (#9953)
* Add EDOT Collector reference docs * Remove artifacts * Add automation script and updates * Add crosslink to troubleshooting * Move script * Update script * Update docs/reference/edot-collector/toc.yml Co-authored-by: Colleen McGinnis <colleen.j.mcginnis@gmail.com> * Update docs/reference/edot-collector/config/proxy.md Co-authored-by: Colleen McGinnis <colleen.j.mcginnis@gmail.com> * Update docs/reference/edot-collector/config/default-config-standalone.md Co-authored-by: Colleen McGinnis <colleen.j.mcginnis@gmail.com> * Update docs/reference/edot-collector/config/default-config-k8s.md Co-authored-by: Colleen McGinnis <colleen.j.mcginnis@gmail.com> * Update docs/reference/edot-collector/components/elasticsearchexporter.md Co-authored-by: Colleen McGinnis <colleen.j.mcginnis@gmail.com> * Update docs/reference/edot-collector/components.md Co-authored-by: Colleen McGinnis <colleen.j.mcginnis@gmail.com> * Modify link * Add items to CODEOWNERS * Remove faulty link and add .gitignore entries * Update .github/workflows/update-docs.yml Co-authored-by: Victor Martinez <victormartinezrubio@gmail.com> * Add dependabot block and update action --------- Co-authored-by: Colleen McGinnis <colleen.j.mcginnis@gmail.com> Co-authored-by: Victor Martinez <victormartinezrubio@gmail.com>
1 parent 779fafd commit e17d861

32 files changed

+2986
-0
lines changed

‎.github/CODEOWNERS‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,9 @@
1515
/dev-tools/kubernetes @elastic/elastic-agent-control-plane
1616
/docs/release-notes @elastic/ingest-docs
1717
/docs/docset.yml @elastic/ingest-docs
18+
/.github/workflows/update-docs.yml @elastic/ingest-docs
19+
/docs/reference/edot-collector @elastic/ingest-docs
20+
/docs/scripts/update-docs @elastic/ingest-docs
1821
/internal/pkg/composable/providers/kubernetes @elastic/elastic-agent-control-plane
1922
/internal/pkg/otel/samples/darwin/autoops_es.yml @elastic/opex
2023
/internal/pkg/otel/samples/linux/autoops_es.yml @elastic/opex

‎.github/dependabot.yml‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,3 +32,16 @@ updates:
3232
- Team:Elastic-Agent-Control-Plane
3333
- backport-active-all
3434
open-pull-requests-limit: 10
35+
36+
- package-ecosystem: "pip"
37+
directory: "/docs/scripts/update-docs"
38+
schedule:
39+
interval: "weekly"
40+
day: "monday"
41+
time: "08:00"
42+
labels:
43+
- automation
44+
- skip-changelog
45+
- Team:Docs
46+
- documentation
47+
open-pull-requests-limit: 5

‎.github/workflows/update-docs.yml‎

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
name: Update documentation
2+
3+
on:
4+
schedule:
5+
# Run weekly on Monday at 8:00 AM UTC
6+
- cron: '0 8 * * 1'
7+
workflow_dispatch:
8+
# Allow manual triggering
9+
10+
jobs:
11+
update-docs:
12+
runs-on: ubuntu-latest
13+
permissions:
14+
contents: write
15+
pull-requests: write
16+
issues: write
17+
steps:
18+
- name: Checkout repository
19+
uses: actions/checkout@v5
20+
21+
- name: Set up Python
22+
uses: actions/setup-python@v6
23+
with:
24+
python-version: '3.13'
25+
cache: 'pip'
26+
27+
- name: Install dependencies
28+
run: |
29+
python -m pip install --upgrade pip
30+
pip install -r docs/scripts/update-docs/requirements.txt
31+
32+
- name: Run documentation generator
33+
run: |
34+
cd docs/scripts/update-docs
35+
python update-components-docs.py
36+
37+
- name: Create Pull Request
38+
uses: peter-evans/create-pull-request@271a8d0340265f705b14b6d32b9829c1cb33d45e # v7.0.8
39+
with:
40+
token: ${{ secrets.GITHUB_TOKEN }}
41+
commit-message: "docs: update generated documentation"
42+
title: "Update generated documentation"
43+
body: |
44+
This PR updates the generated documentation based on the latest local repository data.
45+
46+
- Updates EDOT Collector component tables
47+
- Updates OpenTelemetry Collector Builder (OCB) configuration
48+
- Uses local version from version.go file
49+
50+
This is an automated PR created by the documentation update workflow.
51+
branch: update-docs
52+
base: main
53+
delete-branch: true
54+
labels: |
55+
documentation
56+
automated-pr

‎.gitignore‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,8 @@ fleet.yml
2727
fleet.enc
2828
fleet.enc.lock
2929
env.sh
30+
.artifacts
31+
/docs/.artifacts
3032

3133
# Editor swap files
3234
*.swp

‎docs/docset.yml‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,11 @@ exclude:
77
cross_links:
88
- docs-content
99
- beats
10+
- opentelemetry
11+
- ecs
1012
toc:
1113
- toc: release-notes
14+
- toc: reference/edot-collector
1215
subs:
1316
agent: "Elastic Agent"
1417
agent-issue: "https://github.com/elastic/elastic-agent/issues/"
@@ -17,3 +20,14 @@ subs:
1720
beats: "Beats"
1821
es: "Elasticsearch"
1922
fleet: "Fleet"
23+
motlp: Elastic Cloud Managed OTLP Endpoint
24+
edot: Elastic Distribution of OpenTelemetry
25+
ecloud: "Elastic Cloud"
26+
edot-cf: "EDOT Cloud Forwarder"
27+
ech: "Elastic Cloud Hosted"
28+
ess: "Elasticsearch Service"
29+
ece: "Elastic Cloud Enterprise"
30+
serverless-full: "Elastic Cloud Serverless"
31+
stack: "Elastic Stack"
32+
kib: "Kibana"
33+
ls: "Logstash"

‎docs/reference/edot-collector/_snippets/edot-collector-auth.md‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
```yaml
2+
extensions:
3+
bearertokenauth:
4+
scheme: "APIKey"
5+
token: "<ENCODED_ELASTICSEARCH_APIKEY>"
6+
7+
apmconfig:
8+
opamp:
9+
protocols:
10+
http:
11+
# Default is localhost:4320
12+
# endpoint: "<CUSTOM_OPAMP_ENDPOINT>"
13+
source:
14+
elasticsearch:
15+
endpoint: "<ELASTICSEARCH_ENDPOINT>"
16+
auth:
17+
authenticator: bearertokenauth
18+
```
19+
20+
:::{note}
21+
For comprehensive authentication configuration options, see [Authentication methods](/reference/edot-collector/config/authentication-methods.md).
22+
:::

‎docs/reference/edot-collector/_snippets/guided-instructions.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
Use the **Add data** screen in Elastic Observability to generate install commands that are already configured with the values you need.
2+
3+
1. Open Elastic Observability.
4+
2. Go to **Add data**.
5+
3. Select what you want to monitor.
6+
4. Follow the instructions.

‎docs/reference/edot-collector/_snippets/process-config.md‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
Process metrics are turned off by default to avoid generating a large volume of timeseries data. To turn on process metrics, uncomment or add the following section inside the `hostmetrics` receiver configuration:
2+
3+
```yaml
4+
process:
5+
mute_process_exe_error: true
6+
mute_process_io_error: true
7+
mute_process_user_error: true
8+
metrics:
9+
process.threads:
10+
enabled: true
11+
process.open_file_descriptors:
12+
enabled: true
13+
process.memory.utilization:
14+
enabled: true
15+
process.disk.operations:
16+
enabled: true
17+
```

‎docs/reference/edot-collector/_snippets/retrieve-credentials.md‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
Retrieve your {{es}} URL and your API key:
2+
3+
1. Retrieve the {{es}} URL for your {{ecloud}} deployment:
4+
5+
1. Go to the [{{ecloud}} console](https://cloud.elastic.co/).
6+
2. Next to your deployment, select **Manage**.
7+
3. Under **Applications** next to **{{es}}**, select **Copy endpoint**.
8+
9+
2. Create an API Key following [these instructions](docs-content://deploy-manage/api-keys/elasticsearch-api-keys.md).

‎docs/reference/edot-collector/_snippets/serverless-endpoint-api.md‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
Follow these steps to retrieve the managed OTLP endpoint URL for your Serverless project:
2+
3+
1. In {{serverless-full}}, open your Observability project.
4+
2. Go to **Add data** → **Application** → **OpenTelemetry**.
5+
3. Select **Managed OTLP Endpoint** in the second step.
6+
4. Copy the OTLP endpoint configuration value.
7+
5. Select **Create API Key** to generate an API key.

0 commit comments

Comments
 (0)