Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Update links in readme, remove no longer existing section from TOC #33

Merged
merged 1 commit into from
Nov 28, 2023
Merged

Update links in readme, remove no longer existing section from TOC #33

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
8 changes: 4 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
<!-- omit in toc -->
# Logstash Dynatrace output plugin

[![Travis Build Status](https://api.travis-ci.com/dynatrace-oss/logstash-output-dynatrace.svg?branch=main)](https://app.travis-ci.com/dynatrace-oss/logstash-output-dynatrace)
Expand All @@ -14,13 +15,12 @@
- [`ingest_endpoint_url`](#ingest_endpoint_url)
- [`api_key`](#api_key)
- [`ssl_verify_none`](#ssl_verify_none)
- [`codec`](#codec)
- [`enable_metric`](#enable_metric)
- [`id`](#id)
- [Troubleshooting issues](#troubleshooting-issues)
- [Enable Debug Logs](#enable-debug-logs)

A [Logstash](https://github.com/elastic/logstash) output plugin for sending logs to the Dynatrace [Generic log ingest API v2](https://www.dynatrace.com/support/help/how-to-use-dynatrace/log-monitoring/log-monitoring-v2/post-log-ingest/).
A [Logstash](https://github.com/elastic/logstash) output plugin for sending logs to the Dynatrace [Generic log ingest API v2](https://docs.dynatrace.com/docs/shortlink/api-log-monitoring-v2-post-ingest).
Please review the documentation for this API before using the plugin.

## Installation Prerequisites
Expand Down Expand Up @@ -81,15 +81,15 @@ The following configuration options are supported by all output plugins:
* Value type is [string](https://www.elastic.co/guide/en/logstash/current/configuration-file-structure.html#string)
* Required

This is the full URL of the [Generic log ingest API v2](https://www.dynatrace.com/support/help/how-to-use-dynatrace/log-monitoring/log-monitoring-v2/post-log-ingest/) endpoint on your ActiveGate.
This is the full URL of the [Generic log ingest API v2](https://docs.dynatrace.com/docs/shortlink/api-log-monitoring-v2-post-ingest/) endpoint on your ActiveGate.
Example: `"ingest_endpoint_url" => "https://abc123456.live.dynatrace.com/api/v2/logs/ingest"`

### `api_key`

* Value type is [string](https://www.elastic.co/guide/en/logstash/current/configuration-file-structure.html#string)
* Required

This is the [Dynatrace API token](https://www.dynatrace.com/support/help/dynatrace-api/basics/dynatrace-api-authentication/) which will be used to authenticate log ingest requests.
This is the [Dynatrace API token](https://docs.dynatrace.com/docs/shortlink/api-authentication) which will be used to authenticate log ingest requests.
It requires the `logs.ingest` (Ingest Logs) scope to be set and it is recommended to limit scope to only this one.
Example: `"api_key" => "dt0c01.4XLO3..."`

Expand Down
6 changes: 3 additions & 3 deletions docs/index.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ include::{include_path}/plugin_header.asciidoc[]

==== Description

A logstash output plugin for sending logs to the Dynatrace https://www.dynatrace.com/support/help/how-to-use-dynatrace/log-monitoring/log-monitoring-v2/post-log-ingest/[Generic log ingest API v2].
A logstash output plugin for sending logs to the Dynatrace https://docs.dynatrace.com/docs/shortlink/api-log-monitoring-v2-post-ingest[Generic log ingest API v2].
Please review the documentation for this API before using the plugin.

[id="plugins-{type}s-{plugin}-options"]
Expand All @@ -44,15 +44,15 @@ output plugins.

* Value type is {logstash-ref}/configuration-file-structure.html#string[string]

This is the full URL of the https://www.dynatrace.com/support/help/how-to-use-dynatrace/log-monitoring/log-monitoring-v2/post-log-ingest/[Generic log ingest API v2] endpoint on your ActiveGate.
This is the full URL of the https://docs.dynatrace.com/docs/shortlink/api-log-monitoring-v2-post-ingest[Generic log ingest API v2] endpoint on your ActiveGate.
Example: `"ingest_endpoint_url" => "https://abc123456.live.dynatrace.com/api/v2/logs/ingest"`

[id="plugins-{type}s-{plugin}-api_key"]
===== `api_key`

* Value type is {logstash-ref}/configuration-file-structure.html#string[string]

This is the https://www.dynatrace.com/support/help/dynatrace-api/basics/dynatrace-api-authentication/[Dynatrace API token] which will be used to authenticate log ingest requests.
This is the https://docs.dynatrace.com/docs/shortlink/api-authentication/[Dynatrace API token] which will be used to authenticate log ingest requests.
It requires the `logs.ingest` (Ingest Logs) scope to be set and it is recommended to limit scope to only this one.
Example: `"api_key" => "dt0c01.4XLO3..."`

Expand Down