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.

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

Add logs documentation #9069

Merged
merged 1 commit into from
Apr 2, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
24 changes: 24 additions & 0 deletions activemq_xml/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,30 @@ To configure this check for an Agent running on a host:

2. [Restart the Agent][117].

##### Log collection

1. Collecting logs is disabled by default in the Datadog Agent, enable it in your `datadog.yaml` file:

```yaml
logs_enabled: true
```

2. Add this configuration block to your `activemq_xml.d/conf.yaml` or `activemq.d/conf.yaml` file to start collecting your ActiveMQ logs:

```yaml
logs:
- type: file
path: "<ACTIVEMQ_BASEDIR>/data/activemq.log"
source: activemq
service: "<SERVICE_NAME>"
- type: file
path: "<ACTIVEMQ_BASEDIR>/data/audit.log"
source: activemq
service: "<SERVICE_NAME>"
```

3. [Restart the Agent][7].

<!-- xxz tab xxx -->
<!-- xxx tab "Containerized" xxx -->

Expand Down
10 changes: 10 additions & 0 deletions activemq_xml/assets/configuration/spec.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -50,3 +50,13 @@ files:
example: [<SUBSCRIBER_1>, <SUBSCRIBER_2>]
- template: instances/http
- template: instances/default
- template: logs
example:
- type: file
path: <ACTIVEMQ_BASEDIR>/data/activemq.log
source: activemq
service: <SERVICE_NAME>
- type: file
path: <ACTIVEMQ_BASEDIR>/data/audit.log
source: activemq
service: <SERVICE_NAME>
25 changes: 25 additions & 0 deletions activemq_xml/datadog_checks/activemq_xml/data/conf.yaml.example
Original file line number Diff line number Diff line change
Expand Up @@ -385,3 +385,28 @@ instances:
## This is useful for cluster-level checks.
#
# empty_default_hostname: false

## Log Section
##
## type - required - Type of log input source (tcp / udp / file / windows_event)
## port / path / channel_path - required - Set port if type is tcp or udp.
## Set path if type is file.
## Set channel_path if type is windows_event.
## source - required - Attribute that defines which Integration sent the logs.
## encoding - optional - For file specifies the file encoding, default is utf-8, other
## possible values are utf-16-le and utf-16-be.
## service - optional - The name of the service that generates the log.
## Overrides any `service` defined in the `init_config` section.
## tags - optional - Add tags to the collected logs.
##
## Discover Datadog log collection: https://docs.datadoghq.com/logs/log_collection/
#
# logs:
# - type: file
# path: <ACTIVEMQ_BASEDIR>/data/activemq.log
# source: activemq
# service: <SERVICE_NAME>
# - type: file
# path: <ACTIVEMQ_BASEDIR>/data/audit.log
# source: activemq
# service: <SERVICE_NAME>
1 change: 1 addition & 0 deletions activemq_xml/manifest.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
{
"categories": [
"processing",
"log collection",
"messaging",
"autodiscovery"
],
Expand Down