-
Notifications
You must be signed in to change notification settings - Fork 203
Add Collector reference docs and automation #9953
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
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 9c6e106
Remove artifacts
theletterf 062eca8
Add automation script and updates
theletterf eeb192d
Add crosslink to troubleshooting
theletterf 0935ddd
Merge branch 'main' into add-collector-docs
theletterf 869b4f8
Move script
theletterf ca34304
Merge branch 'add-collector-docs' of github.com:theletterf/elastic-ag…
theletterf e1c90f8
Update script
theletterf beeb4e5
Merge branch 'main' into add-collector-docs
theletterf 4760423
Update docs/reference/edot-collector/toc.yml
theletterf 3e7bf8c
Update docs/reference/edot-collector/config/proxy.md
theletterf 496256b
Update docs/reference/edot-collector/config/default-config-standalone.md
theletterf 567906f
Update docs/reference/edot-collector/config/default-config-k8s.md
theletterf 2cc0df8
Update docs/reference/edot-collector/components/elasticsearchexporter.md
theletterf 3fd16ad
Update docs/reference/edot-collector/components.md
theletterf 842b950
Merge branch 'main' into add-collector-docs
theletterf 1e1a940
Modify link
theletterf 0bddd3c
Merge branch 'add-collector-docs' of github.com:theletterf/elastic-ag…
theletterf d861740
Add items to CODEOWNERS
theletterf 0d3dd5c
Remove faulty link and add .gitignore entries
theletterf df3a142
Update .github/workflows/update-docs.yml
theletterf 4edf491
Add dependabot block and update action
theletterf File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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: | ||
theletterf marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| 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 | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -27,6 +27,8 @@ fleet.yml | |
| fleet.enc | ||
| fleet.enc.lock | ||
| env.sh | ||
| .artifacts | ||
| /docs/.artifacts | ||
|
|
||
| # Editor swap files | ||
| *.swp | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
22 changes: 22 additions & 0 deletions
22
docs/reference/edot-collector/_snippets/edot-collector-auth.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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). | ||
| ::: |
6 changes: 6 additions & 0 deletions
6
docs/reference/edot-collector/_snippets/guided-instructions.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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 | ||
| ``` |
9 changes: 9 additions & 0 deletions
9
docs/reference/edot-collector/_snippets/retrieve-credentials.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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). |
7 changes: 7 additions & 0 deletions
7
docs/reference/edot-collector/_snippets/serverless-endpoint-api.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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" |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.