Ziele erstellen und verwalten
Zuletzt aktualisiert am
Voraussetzungen
Abschnitt betitelt „Voraussetzungen“- Sie verfügen über eine Telemetry Router-Instanz. Instanzen erstellen und verwalten
Ziel-Konfigurationsobjekt
Abschnitt betitelt „Ziel-Konfigurationsobjekt“Um ein Ziel zu konfigurieren, müssen Sie eine Ziel-uri, einen Typ und eine Authentifizierung angeben.
Sie fügen die Zielkonfiguration als JSON-Key namens config zu den entsprechenden Anfragen hinzu. Die folgende Tabelle zeigt die verfügbaren Keys innerhalb dieses Objekts:
| Key | Bedeutung | Typ |
|---|---|---|
| accessToken | Das individuelle Zugriffstoken Ihres Service Accounts | eyJhbGci0iJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIi0iIxMjM0NTY30DkwIiwibmFtZSI6IkpvaG4gRG91IiwiaXNTb2NpYWwiOnRydWV9.4pcPyMD09o1PSyXnrXCjTwXyr4BsezdI1AVTmud2fU4 |
| configType | Typ des Ziels (OpenTelemetry oder S3) | string |
| openTelemetry | Objekt, das ein OpenTelemetry-Ziel beschreibt. Weitere Informationen finden Sie unter Konfiguration für OpenTelemetry-Ziele. | object |
| s3 | Objekt, das ein S3-Ziel beschreibt. Weitere Informationen finden Sie unter Konfiguration für S3-Ziele. | object |
| filter | Ein optionales Filter-Objekt. Lesen Sie Filter, um zu erfahren, wie Filter funktionieren. | object |
Konfiguration für OpenTelemetry-Ziele
Abschnitt betitelt „Konfiguration für OpenTelemetry-Ziele“Um ein OpenTelemetry-Ziel zu konfigurieren, ist das openTelemetry-Objekt obligatorisch. Es besteht aus einer URI und Authentifizierungsparametern. Für die Authentifizierung muss entweder basicAuth oder bearerToken angegeben werden.
| Key | Bedeutung | Typ |
|---|---|---|
| uri | Der tatsächliche Ziel-Endpunkt. Das Limit liegt bei 1024 Zeichen. | string |
| basicAuth | Ein verschachteltes Objekt, das Informationen zur Authentifizierung Ihrer OpenTelemetry-Instanz gegenüber Ihrem Ziel enthält | Siehe Beispiele unten |
| bearerToken | Ein Token-String zur Authentifizierung Ihrer OpenTelemetry-Instanz gegenüber Ihrem Ziel | string |
Basic-Auth-Objekt
Abschnitt betitelt „Basic-Auth-Objekt“Das Basic-Auth-Objekt besteht aus zwei Keys:
| Key | Bedeutung | Typ |
|---|---|---|
| username | Der Benutzername für die Authentifizierung gegenüber Ihrem Endpunkt | string |
| password | Das Passwort für die Authentifizierung gegenüber Ihrem Endpunkt | string |
Beispiel für ein Konfigurationsobjekt
Abschnitt betitelt „Beispiel für ein Konfigurationsobjekt“{ "configType": "OpenTelemetry", "openTelemetry": { "basicAuth": { "username": "stackit-open-telemetry-client", "password": "my-top-secret-password" }, "uri": "[https://my-opentelemetry-destination.on-prem-cloud.example.com](https://my-opentelemetry-destination.on-prem-cloud.example.com)" }, "displayName": "My Open Telemetry destination"}Konfiguration für S3-Ziele
Abschnitt betitelt „Konfiguration für S3-Ziele“Um ein S3-Ziel zu konfigurieren, ist das s3-Objekt obligatorisch. Es besteht aus einer Endpunkt-Bucket-Kombination und Authentifizierungsparametern. Für die Authentifizierung muss ein accessKey angegeben werden.
| Key | Bedeutung | Typ |
|---|---|---|
| accessKey | Der Zugriffsschlüssel für die Authentifizierung | object |
| bucket | Die Kennung Ihres Buckets. Das Limit liegt bei 63 Zeichen. | string |
| endpoint | Die Endpunkt-URI. Das Limit liegt bei 1024 Zeichen. | string |
Access-Key-Objekt
Abschnitt betitelt „Access-Key-Objekt“Das Access-Key-Objekt besteht aus zwei Keys:
| Key | Bedeutung | Typ |
|---|---|---|
| id | Die ID Ihres Zugriffsschlüssels | string |
| secret | Das Secret für die Authentifizierung gegenüber Ihrem S3-Endpunkt | string |
Beispiel für ein Konfigurationsobjekt
Abschnitt betitelt „Beispiel für ein Konfigurationsobjekt“{
"configType": "S3", "s3": { "accessKey": { "id": "stackit-s3-client", "secret": "my-secret" }, "bucket": "my-bucket", "endpoint": "[https://my-s3-bucket.on-prem-cloud.example.com](https://my-s3-bucket.on-prem-cloud.example.com)" }, "displayName": "My S3 destination"}Ziel erstellen
Abschnitt betitelt „Ziel erstellen“Um ein Ziel für den Telemetry Router zu erstellen, müssen Sie den entsprechenden Endpunkt aufrufen.
Eigenschaften für Ihr neues Ziel wählen
Abschnitt betitelt „Eigenschaften für Ihr neues Ziel wählen“| Parameter | Bedeutung | Beispiel |
|---|---|---|
| accessToken | Das individuelle Zugriffstoken Ihres Service Accounts | eyJhbGci0iJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIi0iIxMjM0NTY30DkwIiwibmFtZSI6IkpvaG4gRG91IiwiaXNTb2NpYWwiOnRydWV9.4pcPyMD09o1PSyXnrXCjTwXyr4BsezdI1AVTmud2fU4 |
| projectId | Ihre individuelle Projekt-ID | 16dbfb51-7a75-42d3-a51d-99f87f48cd32 |
| regionId | Die Region, in der sich Ihre Telemetry Router-Instanz befindet | eu01 |
| telemetryRouterId | Die ID Ihrer Telemetry Router-Instanz | d5b5cdcc-c155-4d66-82ef-4289db8e4557 |
| config | Ein JSON-Objekt, das das eigentliche Ziel beschreibt | Siehe #ziel-konfigurationsobjekt |
| displayName | Ein Name für das Ziel | my-telemetry-destination |
| description | Eine optionale Beschreibung für Ihre Unterlagen | My new Telemetry Router destination |
curl -X POST \'[https://telemetry-router.api.stackit.cloud/v1beta/projects/](https://telemetry-router.api.stackit.cloud/v1beta/projects/)[projectId]/regions/[regionId]/telemetry-routers/[telemetryRouterId]/destinations' \--header 'Authorization: Bearer [accessToken]' \--header 'Content-Type: application/json' \--data-raw '{ "displayName": [displayName], "description": [description], "config": [config]}'Beispiel für ein S3-kompatibles Speicherziel
Abschnitt betitelt „Beispiel für ein S3-kompatibles Speicherziel“curl -X POST \'[https://telemetry-router.api.eu01.stackit.cloud/v1beta/projects/16dbfb51-7a75-42d3-a51d-99f87f48cd32/regions/eu01/telemetry-routers/d5b5cdcc-c155-4d66-82ef-4289db8e4557/destinations](https://telemetry-router.api.eu01.stackit.cloud/v1beta/projects/16dbfb51-7a75-42d3-a51d-99f87f48cd32/regions/eu01/telemetry-routers/d5b5cdcc-c155-4d66-82ef-4289db8e4557/destinations)' \--header 'Authorization: Bearer eyJhbGci0iJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIi0iIxMjM0NTY30DkwIiwibmFtZSI6IkpvaG4gRG91IiwiaXNTb2NpYWwiOnRydWV9.4pcPyMD09o1PSyXnrXCjTwXyr4BsezdI1AVTmud2fU4' \--header 'Content-Type: application/json' \--data-raw '{ "displayName": "my-telemetry-destination", "description": "My telemetry destination", "config": { "configType": "S3", "s3": { "accessKey": { "id": "stackit-s3-client", "secret": "my-secret" }, "bucket": "my-bucket", "endpoint": "[https://my-s3-bucket.on-prem-cloud.example.com](https://my-s3-bucket.on-prem-cloud.example.com)" }, "displayName": "My S3 destination" }}'Beispiel für ein OpenTelemetry-Ziel
Abschnitt betitelt „Beispiel für ein OpenTelemetry-Ziel“curl -X POST \'[https://telemetry-router.api.eu01.stackit.cloud/v1beta/projects/16dbfb51-7a75-42d3-a51d-99f87f48cd32/regions/eu01/telemetry-routers/d5b5cdcc-c155-4d66-82ef-4289db8e4557/destinations](https://telemetry-router.api.eu01.stackit.cloud/v1beta/projects/16dbfb51-7a75-42d3-a51d-99f87f48cd32/regions/eu01/telemetry-routers/d5b5cdcc-c155-4d66-82ef-4289db8e4557/destinations)' \--header 'Authorization: Bearer eyJhbGci0iJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIi0iIxMjM0NTY30DkwIiwibmFtZSI6IkpvaG4gRG91IiwiaXNTb2NpYWwiOnRydWV9.4pcPyMD09o1PSyXnrXCjTwXyr4BsezdI1AVTmud2fU4' \--header 'Content-Type: application/json' \--data-raw '{ "displayName": "my-telemetry-destination", "description": "My telemetry destination", "config": { "configType": "OpenTelemetry", "openTelemetry": { "basicAuth": { "username": "stackit-open-telemetry-client", "password": "my-top-secret-password" }, "uri": "[https://my-opentelemetry-destination.on-prem-cloud.example.com](https://my-opentelemetry-destination.on-prem-cloud.example.com)" }, "displayName": "My Open Telemetry destination" }}'Alle Ziele auflisten
Abschnitt betitelt „Alle Ziele auflisten“| Parameter | Bedeutung | Beispiel |
|---|---|---|
| accessToken | Das individuelle Zugriffstoken Ihres Service Accounts | eyJhbGci0iJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIi0iIxMjM0NTY30DkwIiwibmFtZSI6IkpvaG4gRG91IiwiaXNTb2NpYWwiOnRydWV9.4pcPyMD09o1PSyXnrXCjTwXyr4BsezdI1AVTmud2fU4 |
| projectId | Ihre individuelle Projekt-ID | 16dbfb51-7a75-42d3-a51d-99f87f48cd32 |
| regionId | Die Region, in der sich Ihre Telemetry Router-Instanz befindet | eu01 |
| telemetryRouterId | Die ID Ihrer Telemetry Router-Instanz | d5b5cdcc-c155-4d66-82ef-4289db8e4557 |
curl -X GET \'[https://telemetry-router.api.stackit.cloud/v1beta/projects/](https://telemetry-router.api.stackit.cloud/v1beta/projects/)[projectId]/regions/[regionId]/telemetry-routers/[telemetryRouterId]/destinations' \--header 'Authorization: Bearer [accessToken]' \--header 'Content-Type: application/json'Beispiel
Abschnitt betitelt „Beispiel“curl -X GET \'[https://telemetry-router.api.eu01.stackit.cloud/v1beta/projects/16dbfb51-7a75-42d3-a51d-99f87f48cd32/regions/eu01/telemetry-routers/d5b5cdcc-c155-4d66-82ef-4289db8e4557/destinations](https://telemetry-router.api.eu01.stackit.cloud/v1beta/projects/16dbfb51-7a75-42d3-a51d-99f87f48cd32/regions/eu01/telemetry-routers/d5b5cdcc-c155-4d66-82ef-4289db8e4557/destinations)' \--header 'Authorization: Bearer eyJhbGci0iJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIi0iIxMjM0NTY30DkwIiwibmFtZSI6IkpvaG4gRG91IiwiaXNTb2NpYWwiOnRydWV9.4pcPyMD09o1PSyXnrXCjTwXyr4BsezdI1AVTmud2fU4' \--header 'Content-Type: application/json'Ziel anzeigen
Abschnitt betitelt „Ziel anzeigen“| Parameter | Bedeutung | Beispiel |
|---|---|---|
| accessToken | Das individuelle Zugriffstoken Ihres Service Accounts | eyJhbGci0iJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIi0iIxMjM0NTY30DkwIiwibmFtZSI6IkpvaG4gRG91IiwiaXNTb2NpYWwiOnRydWV9.4pcPyMD09o1PSyXnrXCjTwXyr4BsezdI1AVTmud2fU4 |
| projectId | Ihre individuelle Projekt-ID | 16dbfb51-7a75-42d3-a51d-99f87f48cd32 |
| regionId | Die Region, in der sich Ihre Telemetry Router-Instanz befindet | eu01 |
| telemetryRouterId | Die ID Ihrer Telemetry Router-Instanz | d5b5cdcc-c155-4d66-82ef-4289db8e4557 |
| destinationId | Die ID Ihres Ziels | 60e59099-8209-4b69-a553-239fd79038a3 |
curl -X GET \'[https://telemetry-router.api.stackit.cloud/v1beta/projects/](https://telemetry-router.api.stackit.cloud/v1beta/projects/)[projectId]/regions/[regionId]/telemetry-routers/[telemetryRouterId]/destinations/[destinationId]' \--header 'Authorization: Bearer [accessToken]' \--header 'Content-Type: application/json'Beispiel
Abschnitt betitelt „Beispiel“curl -X GET \'[https://telemetry-router.api.eu01.stackit.cloud/v1beta/projects/16dbfb51-7a75-42d3-a51d-99f87f48cd32/regions/eu01/telemetry-routers/d5b5cdcc-c155-4d66-82ef-4289db8e4557/destinations/60e59099-8209-4b69-a553-239fd79038a3](https://telemetry-router.api.eu01.stackit.cloud/v1beta/projects/16dbfb51-7a75-42d3-a51d-99f87f48cd32/regions/eu01/telemetry-routers/d5b5cdcc-c155-4d66-82ef-4289db8e4557/destinations/60e59099-8209-4b69-a553-239fd79038a3)' \--header 'Authorization: Bearer eyJhbGci0iJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIi0iIxMjM0NTY30DkwIiwibmFtZSI6IkpvaG4gRG91IiwiaXNTb2NpYWwiOnRydWV9.4pcPyMD09o1PSyXnrXCjTwXyr4BsezdI1AVTmud2fU4' \--header 'Content-Type: application/json'Ziel bearbeiten
Abschnitt betitelt „Ziel bearbeiten“| Parameter | Bedeutung | Beispiel |
|---|---|---|
| accessToken | Das individuelle Zugriffstoken Ihres Service Accounts | eyJhbGci0iJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIi0iIxMjM0NTY30DkwIiwibmFtZSI6IkpvaG4gRG91IiwiaXNTb2NpYWwiOnRydWV9.4pcPyMD09o1PSyXnrXCjTwXyr4BsezdI1AVTmud2fU4 |
| projectId | Ihre individuelle Projekt-ID | 16dbfb51-7a75-42d3-a51d-99f87f48cd32 |
| regionId | Die Region, in der sich Ihre Telemetry Router-Instanz befindet | eu01 |
| telemetryRouterId | Die ID Ihrer Telemetry Router-Instanz | d5b5cdcc-c155-4d66-82ef-4289db8e4557 |
| destinationId | Die ID Ihres Ziels | 60e59099-8209-4b69-a553-239fd79038a3 |
| displayName | Ein Name für die Telemetry Router-Instanz. In diesem Endpunkt ist der Parameter optional. | my-telemetry-router |
| description | Eine optionale Beschreibung für Ihre Unterlagen | My Telemetry Router instance |
| config | Ein Ziel-Konfigurationsobjekt. | Lesen Sie Ziel-Konfigurationsobjekt, um mehr über die Syntax der Zielkonfiguration zu erfahren. |
curl -X PUT \'[https://telemetry-router.api.stackit.cloud/v1beta/projects/](https://telemetry-router.api.stackit.cloud/v1beta/projects/)[projectId]/regions/[regionId]/telemetry-routers/[telemetryRouterId]/destinations/[destinationId]' \--header 'Authorization: Bearer [accessToken]' \--header 'Content-Type: application/json'--data-raw '{ "displayName": [name], "description": [description], "config": [config]}'Beispiel für die Bearbeitung eines Ziels zu einem S3-kompatiblen Speicher für eine bestehende Telemetry Router-Instanz
Abschnitt betitelt „Beispiel für die Bearbeitung eines Ziels zu einem S3-kompatiblen Speicher für eine bestehende Telemetry Router-Instanz“curl -X PUT \'[https://telemetry-router.api.eu01.stackit.cloud/v1beta/projects/16dbfb51-7a75-42d3-a51d-99f87f48cd32/regions/eu01/telemetry-routers/d5b5cdcc-c155-4d66-82ef-4289db8e4557/destinations/60e59099-8209-4b69-a553-239fd79038a3](https://telemetry-router.api.eu01.stackit.cloud/v1beta/projects/16dbfb51-7a75-42d3-a51d-99f87f48cd32/regions/eu01/telemetry-routers/d5b5cdcc-c155-4d66-82ef-4289db8e4557/destinations/60e59099-8209-4b69-a553-239fd79038a3)' \--header 'Authorization: Bearer eyJhbGci0iJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIi0iIxMjM0NTY30DkwIiwibmFtZSI6IkpvaG4gRG91IiwiaXNTb2NpYWwiOnRydWV9.4pcPyMD09o1PSyXnrXCjTwXyr4BsezdI1AVTmud2fU4' \--header 'Content-Type: application/json' \--data-raw '{ "config": { "configType": "S3", "s3": { "accessKey": { "id": "stackit-s3-client", "secret": "my-secret" }, "bucket": "my-bucket", "endpoint": "[https://my-s3-bucket.on-prem-cloud.example.com](https://my-s3-bucket.on-prem-cloud.example.com)" }, "displayName": "My S3 destination" }}'Beispiel für die Bearbeitung eines Ziels zu einem OpenTelemetry-Speicher für eine bestehende Telemetry Router-Instanz
Abschnitt betitelt „Beispiel für die Bearbeitung eines Ziels zu einem OpenTelemetry-Speicher für eine bestehende Telemetry Router-Instanz“curl -X PUT \'[https://telemetry-router.api.eu01.stackit.cloud/v1beta/projects/16dbfb51-7a75-42d3-a51d-99f87f48cd32/regions/eu01/telemetry-routers/d5b5cdcc-c155-4d66-82ef-4289db8e4557/destinations/60e59099-8209-4b69-a553-239fd79038a3](https://telemetry-router.api.eu01.stackit.cloud/v1beta/projects/16dbfb51-7a75-42d3-a51d-99f87f48cd32/regions/eu01/telemetry-routers/d5b5cdcc-c155-4d66-82ef-4289db8e4557/destinations/60e59099-8209-4b69-a553-239fd79038a3)' \--header 'Authorization: Bearer eyJhbGci0iJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIi0iIxMjM0NTY30DkwIiwibmFtZSI6IkpvaG4gRG91IiwiaXNTb2NpYWwiOnRydWV9.4pcPyMD09o1PSyXnrXCjTwXyr4BsezdI1AVTmud2fU4' \--header 'Content-Type: application/json' \--data-raw '{ "config": { "configType": "OpenTelemetry", "openTelemetry": { "basicAuth": { "username": "stackit-open-telemetry-client", "password": "my-top-secret-password" }, "uri": "[https://my-opentelemetry-destination.on-prem-cloud.example.com](https://my-opentelemetry-destination.on-prem-cloud.example.com)" }, "displayName": "My Open Telemetry destination" }}'Ziel löschen
Abschnitt betitelt „Ziel löschen“Um eine Telemetry Router-Instanz zu löschen, müssen Sie den DELETE-Endpunkt aufrufen.
| Parameter | Bedeutung | Beispiel |
|---|---|---|
| accessToken | Das individuelle Zugriffstoken Ihres Service Accounts | eyJhbGci0iJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIi0iIxMjM0NTY30DkwIiwibmFtZSI6IkpvaG4gRG91IiwiaXNTb2NpYWwiOnRydWV9.4pcPyMD09o1PSyXnrXCjTwXyr4BsezdI1AVTmud2fU4 |
| projectId | Ihre individuelle Projekt-ID | 16dbfb51-7a75-42d3-a51d-99f87f48cd32 |
| regionId | Die Region, in der sich Ihre Telemetry Router-Instanz befindet | eu01 |
| telemetryRouterId | Die ID Ihrer Telemetry Router-Instanz | d5b5cdcc-c155-4d66-82ef-4289db8e4557 |
| destinationId | Die ID Ihres Ziels | 60e59099-8209-4b69-a553-239fd79038a3 |
curl -X DELETE \'[https://telemetry-router.api.stackit.cloud/v1beta/projects/](https://telemetry-router.api.stackit.cloud/v1beta/projects/)[projectId]/regions/[regionId]/telemetry-routers/[telemetryRouterId]/destinations/[destinationId]' \--header 'Authorization: Bearer [accessToken]' \--header 'Content-Type: application/json' \Beispiel:
curl -X DELETE \'[https://telemetry-router.api.eu01.stackit.cloud/v1beta/projects/16dbfb51-7a75-42d3-a51d-99f87f48cd32/regions/eu01/telemetry-routers/d5b5cdcc-c155-4d66-82ef-4289db8e4557/destinations/60e59099-8209-4b69-a553-239fd79038a3](https://telemetry-router.api.eu01.stackit.cloud/v1beta/projects/16dbfb51-7a75-42d3-a51d-99f87f48cd32/regions/eu01/telemetry-routers/d5b5cdcc-c155-4d66-82ef-4289db8e4557/destinations/60e59099-8209-4b69-a553-239fd79038a3)' \--header 'Authorization: Bearer eyJhbGci0iJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIi0iIxMjM0NTY30DkwIiwibmFtZSI6IkpvaG4gRG91IiwiaXNTb2NpYWwiOnRydWV9.4pcPyMD09o1PSyXnrXCjTwXyr4BsezdI1AVTmud2fU4' \--header 'Content-Type: application/json' \