-
Notifications
You must be signed in to change notification settings - Fork 127
OTel configuration file generator #5443
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
Open
cg-tw
wants to merge
6
commits into
staging
Choose a base branch
from
LOG-1377-configurator
base: staging
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
1beac4d
OTel configuration file generator
cg-tw 91fcd49
Change topic order
cg-tw 6f76661
Remove obsolete file and adapt full procedure
cg-tw c2cc852
Add link
cg-tw 6628e08
Changes following review
cg-tw 7121c36
Merge branch 'staging' into LOG-1377-configurator
cg-tw 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
38 changes: 38 additions & 0 deletions
38
...urus-plugin-content-docs-logmanagement/current/collector/collector-generator.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,38 @@ | ||
| --- | ||
| id: collector-generator | ||
| title: Générer un fichier de configuration de collecteur OTel | ||
| --- | ||
|
|
||
| La configuration d'un collecteur OpenTelemetry peut être complexe. Log Management propose une interface où vous sélectionnez des extraits de configuration pour vos sources de données (snippets), puis les adaptez à votre environnement. Vous téléchargez ensuite le résultat, prêt à l'emploi. | ||
|
|
||
| D'autres sources de données seront ajoutées au fil du temps. Si votre source de données ne figure pas dans la liste, utilisez plutôt la [procédure de configuration manuelle](collector.md). | ||
|
|
||
| Le fichier généré contient des receivers, des processors et des exporters, comme expliqué dans [Fonctionnement d'un collecteur OpenTelemetry](opentelemetry-collector.md). | ||
|
|
||
| ## Étape 1 : Configurer les receivers | ||
|
|
||
| 1. Allez à la page **OTel collector configurator**, puis cliquez sur **Create**. | ||
| 2. Dans la fenêtre qui s'ouvre, sélectionnez le pack correspondant à la source de données souhaitée : | ||
| * Utilisez la barre de recherche en haut de la fenêtre, ou | ||
| * Cliquez sur **Add pack** dans la section **Configure packs**. | ||
|
|
||
| Pour le moment, un pack contient un seul snippet. | ||
|
|
||
| Une fois le pack sélectionné, un résumé apparaît dans la section **Configure packs** et le panneau **Preview configuration YAML** est mis à jour. Votre source de données est alors ajoutée à la section **receivers** du fichier de configuration. | ||
| 3. Vérifiez que le fichier de log affiché dans la section **Configure packs** pour votre source de données est correct. | ||
|
|
||
| ## Étape 2 : Configurer les processors | ||
|
|
||
| 1. Activez et configurez les paramètres souhaités dans la section **Configure processors**. Ceux-ci seront ajoutés à la section **processors** du fichier de configuration et s'appliqueront à toutes les sources de données. | ||
|
cg-tw marked this conversation as resolved.
|
||
| 2. Vérifiez que tout est correct dans le panneau **Preview configuration YAML**. | ||
| * Un exporter pour Centreon Log Management est déjà pré-configuré (vous devrez le compléter à l'[étape 3](#étape-3--renseigner-le-jeton-dauthentification-pour-centreon-log-management)). | ||
| * Le pipeline adapté à vos receivers, processor et exporter est généré automatiquement. | ||
|
|
||
| ## Étape 3 : Renseigner le jeton d'authentification pour Centreon Log Management | ||
|
|
||
| 1. Copiez ou téléchargez votre fichier de configuration à l'aide des boutons en bas de la fenêtre. | ||
| 2. Avant de déployer votre fichier de configuration, remplacez la valeur d'exemple dans le champ **X-Api-Key** par votre [jeton d'authentification](../administration/tokens.md) Log Management. | ||
|
|
||
| ## Étape 4 : Déployer votre fichier de configuration | ||
|
|
||
| Déployez votre fichier de configuration sur le serveur depuis lequel vous souhaitez collecter des logs. | ||
232 changes: 0 additions & 232 deletions
232
...usaurus-plugin-content-docs-logmanagement/current/collector/collector-simple.md
This file was deleted.
Oops, something went wrong.
8 changes: 5 additions & 3 deletions
8
.../fr/docusaurus-plugin-content-docs-logmanagement/current/collector/collector.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
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,38 @@ | ||
| --- | ||
| id: collector-generator | ||
| title: Generating an OTel collector configuration file | ||
| --- | ||
|
|
||
| Configuring an OpenTelemetry Collector can be complex. Log Management provides an interface where you can select configuration snippets for your data sources and edit them to match your setup. You then download the ready-to-use result. | ||
|
|
||
| More data sources will be added over time. If your data source is not listed, use the [manual configuration procedure](collector.md) instead. | ||
|
|
||
| The generated file contains receivers, processors and exporters as explained in [How an OpenTelemetry collector works](opentelemetry-collector.md). | ||
|
|
||
| ## Step 1: Configure receivers | ||
|
|
||
| 1. Go to **OTel collector configurator** and then click **Create**. | ||
| 2. In the window that opens, select the correct pack for the data source you want: | ||
| * Use the search bar at the top of the window, or | ||
| * Click **Add pack** in the **Configure packs** section. | ||
|
|
||
| At the moment, a pack contains just one snippet. | ||
|
|
||
| Once you have selected a pack, a summary appears in the **Configure packs** section and the **Preview configuration YAML** panel is updated. Your data source is then added to the **receivers** section of the configuration file. | ||
| 3. Check that the log file displayed in the **Configure packs** section for your data source is correct. | ||
|
|
||
| ## Step 2: Configure processors | ||
|
|
||
| 1. Enable and configure any parameters you want in the **Configure processors** section. These will be added to the **processors** section of the configuration file and will apply to every data source. | ||
| 2. Check that everything is correct in the **Preview configuration YAML** panel. | ||
| * An exporter for Centreon Log Management is already pre-configured (you will have to complete it in [step 3](#step-3-enter-the-authentication-token-for-centreon-log-management)). | ||
| * The correct pipeline for your receivers, processor and exporter is generated automatically. | ||
|
|
||
| ## Step 3: Enter the authentication token for Centreon Log Management | ||
|
|
||
| 1. Copy or download your configuration file using the buttons at the bottom of the window. | ||
| 2. Before you deploy your configuration file, make sure you replace the placeholder value in the **X-Api-Key** field with your Log Management [authentication token](../administration/tokens.md). | ||
|
|
||
| ## Step 4: Deploy your configuration file | ||
|
|
||
| Deploy your configuration file on the server you want to collect logs from. |
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.