Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
22 commits
Select commit Hold shift + click to select a range
1e64b25
Add EDOT Collector reference docs
theletterf Sep 14, 2025
9c6e106
Remove artifacts
theletterf Sep 15, 2025
062eca8
Add automation script and updates
theletterf Sep 15, 2025
eeb192d
Add crosslink to troubleshooting
theletterf Sep 15, 2025
0935ddd
Merge branch 'main' into add-collector-docs
theletterf Sep 15, 2025
869b4f8
Move script
theletterf Sep 15, 2025
ca34304
Merge branch 'add-collector-docs' of github.com:theletterf/elastic-ag…
theletterf Sep 15, 2025
e1c90f8
Update script
theletterf Sep 15, 2025
beeb4e5
Merge branch 'main' into add-collector-docs
theletterf Sep 15, 2025
4760423
Update docs/reference/edot-collector/toc.yml
theletterf Sep 16, 2025
3e7bf8c
Update docs/reference/edot-collector/config/proxy.md
theletterf Sep 16, 2025
496256b
Update docs/reference/edot-collector/config/default-config-standalone.md
theletterf Sep 16, 2025
567906f
Update docs/reference/edot-collector/config/default-config-k8s.md
theletterf Sep 16, 2025
2cc0df8
Update docs/reference/edot-collector/components/elasticsearchexporter.md
theletterf Sep 16, 2025
3fd16ad
Update docs/reference/edot-collector/components.md
theletterf Sep 16, 2025
842b950
Merge branch 'main' into add-collector-docs
theletterf Sep 16, 2025
1e1a940
Modify link
theletterf Sep 16, 2025
0bddd3c
Merge branch 'add-collector-docs' of github.com:theletterf/elastic-ag…
theletterf Sep 16, 2025
d861740
Add items to CODEOWNERS
theletterf Sep 16, 2025
0d3dd5c
Remove faulty link and add .gitignore entries
theletterf Sep 16, 2025
df3a142
Update .github/workflows/update-docs.yml
theletterf Sep 16, 2025
4edf491
Add dependabot block and update action
theletterf Sep 16, 2025
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .github/CODEOWNERS
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,9 @@
/dev-tools/kubernetes @elastic/elastic-agent-control-plane
/docs/release-notes @elastic/ingest-docs
/docs/docset.yml @elastic/ingest-docs
/.github/workflows/update-docs.yml @elastic/ingest-docs
/docs/reference/edot-collector @elastic/ingest-docs
/docs/scripts/update-docs @elastic/ingest-docs
/internal/pkg/composable/providers/kubernetes @elastic/elastic-agent-control-plane
/internal/pkg/otel/samples/darwin/autoops_es.yml @elastic/opex
/internal/pkg/otel/samples/linux/autoops_es.yml @elastic/opex
Expand Down
13 changes: 13 additions & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
Expand Up @@ -32,3 +32,16 @@ updates:
- Team:Elastic-Agent-Control-Plane
- backport-active-all
open-pull-requests-limit: 10

- package-ecosystem: "pip"
directory: "/docs/scripts/update-docs"
schedule:
interval: "weekly"
day: "monday"
time: "08:00"
labels:
- automation
- skip-changelog
- Team:Docs
- documentation
open-pull-requests-limit: 5
56 changes: 56 additions & 0 deletions .github/workflows/update-docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
name: Update documentation

on:
schedule:
# Run weekly on Monday at 8:00 AM UTC
- cron: '0 8 * * 1'
workflow_dispatch:
# Allow manual triggering

jobs:
update-docs:
runs-on: ubuntu-latest
permissions:
contents: write
pull-requests: write
issues: write
steps:
- name: Checkout repository
uses: actions/checkout@v5

- name: Set up Python
uses: actions/setup-python@v6
with:
python-version: '3.13'
cache: 'pip'

- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install -r docs/scripts/update-docs/requirements.txt

- name: Run documentation generator
run: |
cd docs/scripts/update-docs
python update-components-docs.py

- name: Create Pull Request
uses: peter-evans/create-pull-request@271a8d0340265f705b14b6d32b9829c1cb33d45e # v7.0.8
with:
token: ${{ secrets.GITHUB_TOKEN }}
commit-message: "docs: update generated documentation"
title: "Update generated documentation"
body: |
This PR updates the generated documentation based on the latest local repository data.

- Updates EDOT Collector component tables
- Updates OpenTelemetry Collector Builder (OCB) configuration
- Uses local version from version.go file

This is an automated PR created by the documentation update workflow.
branch: update-docs
base: main
delete-branch: true
labels: |
documentation
automated-pr
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,8 @@ fleet.yml
fleet.enc
fleet.enc.lock
env.sh
.artifacts
/docs/.artifacts

# Editor swap files
*.swp
Expand Down
14 changes: 14 additions & 0 deletions docs/docset.yml
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
project: Elastic Agent docs
products:
- id: elastic-agent
Expand All @@ -7,8 +7,11 @@
cross_links:
- docs-content
- beats
- opentelemetry
- ecs
toc:
- toc: release-notes
- toc: reference/edot-collector
subs:
agent: "Elastic Agent"
agent-issue: "https://github.com/elastic/elastic-agent/issues/"
Expand All @@ -17,3 +20,14 @@
beats: "Beats"
es: "Elasticsearch"
fleet: "Fleet"
motlp: Elastic Cloud Managed OTLP Endpoint
edot: Elastic Distribution of OpenTelemetry
ecloud: "Elastic Cloud"
edot-cf: "EDOT Cloud Forwarder"
ech: "Elastic Cloud Hosted"
ess: "Elasticsearch Service"
ece: "Elastic Cloud Enterprise"
serverless-full: "Elastic Cloud Serverless"
stack: "Elastic Stack"
kib: "Kibana"
ls: "Logstash"
22 changes: 22 additions & 0 deletions docs/reference/edot-collector/_snippets/edot-collector-auth.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
```yaml
extensions:
bearertokenauth:
scheme: "APIKey"
token: "<ENCODED_ELASTICSEARCH_APIKEY>"

apmconfig:
opamp:
protocols:
http:
# Default is localhost:4320
# endpoint: "<CUSTOM_OPAMP_ENDPOINT>"
source:
elasticsearch:
endpoint: "<ELASTICSEARCH_ENDPOINT>"
auth:
authenticator: bearertokenauth
```

:::{note}
For comprehensive authentication configuration options, see [Authentication methods](/reference/edot-collector/config/authentication-methods.md).
:::
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
Use the **Add data** screen in Elastic Observability to generate install commands that are already configured with the values you need.

1. Open Elastic Observability.
2. Go to **Add data**.
3. Select what you want to monitor.
4. Follow the instructions.
17 changes: 17 additions & 0 deletions docs/reference/edot-collector/_snippets/process-config.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
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:

```yaml
process:
mute_process_exe_error: true
mute_process_io_error: true
mute_process_user_error: true
metrics:
process.threads:
enabled: true
process.open_file_descriptors:
enabled: true
process.memory.utilization:
enabled: true
process.disk.operations:
enabled: true
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
Retrieve your {{es}} URL and your API key:

1. Retrieve the {{es}} URL for your {{ecloud}} deployment:

1. Go to the [{{ecloud}} console](https://cloud.elastic.co/).
2. Next to your deployment, select **Manage**.
3. Under **Applications** next to **{{es}}**, select **Copy endpoint**.

2. Create an API Key following [these instructions](docs-content://deploy-manage/api-keys/elasticsearch-api-keys.md).
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
Follow these steps to retrieve the managed OTLP endpoint URL for your Serverless project:

1. In {{serverless-full}}, open your Observability project.
2. Go to **Add data** → **Application** → **OpenTelemetry**.
3. Select **Managed OTLP Endpoint** in the second step.
4. Copy the OTLP endpoint configuration value.
5. Select **Create API Key** to generate an API key.
27 changes: 27 additions & 0 deletions docs/reference/edot-collector/component-docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# Component Documentation Registry
# Maps component names to their documentation files
# Used by tools.py to generate links to local documentation

components:
# Exporters
elasticsearchexporter:
doc_path: "/reference/edot-collector/components/elasticsearchexporter.md"
title: "Elasticsearch exporter"

# Receivers
elasticapmintakereceiver:
doc_path: "/reference/edot-collector/components/elasticapmintakereceiver.md"
title: "Elastic APM intake receiver"

apikeyauthextension:
doc_path: "/reference/edot-collector/config/authentication-methods.md"
title: "Authentication methods"

bearertokenauthextension:
doc_path: "/reference/edot-collector/config/authentication-methods.md"
title: "Authentication methods"

# Add more components as documentation is created
# elasticapmconnector:
# doc_path: "/reference/edot-collector/components/elasticapmconnector"
# title: "Elastic APM connector"
Loading
Loading