Skip to content

Send logs to support using flare

Jump to bottom
Olivier Vielpeau edited this page Sep 14, 2015 · 3 revisions

Datadog Agent flare

Datadog agent embeds a flare command, making it easy for you to ship a tarball with your logs and configs to ease agent troubleshooting.

Requirements

Minimum supported version:

Operating system Datadog agent version
Linux 5.3.0
OS X 5.4.0
Windows 5.5.0

How to run the flare command?

The flare command asks for confirmation before uploading the logs to Datadog

Linux & OS X

On packaged version

On Linux systems, run

sudo /etc/init.d/datadog-agent flare {case_id}

On OS X,

datadog-agent flare {case_id}

where case_id is optional and will be communicated by Datadog support to attach your logs to an existing support case.

On source install

Run,

sudo ~/.datadog-agent/bin/agent flare {case_id}

case_id is optional and will be communicated by Datadog support to attach your logs to an existing support case.

Example output:

2015-03-12 22:51:06,106 | INFO | dd.collector | flare(flare.py:91) | Collecting logs and configuration files:
2015-03-12 22:51:06,107 | INFO | dd.collector | flare(flare.py:163) |   * /var/log/datadog/collector.log
2015-03-12 22:51:06,111 | INFO | dd.collector | flare(flare.py:163) |   * /var/log/datadog/forwarder.log.1
2015-03-12 22:51:07,767 | INFO | dd.collector | flare(flare.py:163) |   * /var/log/datadog/forwarder.log
2015-03-12 22:51:08,330 | INFO | dd.collector | flare(flare.py:163) |   * /var/log/datadog/dogstatsd.log
2015-03-12 22:51:08,637 | INFO | dd.collector | flare(flare.py:163) |   * /var/log/datadog/dogstatsd.log.1
2015-03-12 22:51:08,650 | INFO | dd.collector | flare(flare.py:163) |   * /var/log/datadog/jmxfetch.log
2015-03-12 22:51:08,876 | INFO | dd.collector | flare(flare.py:163) |   * /var/log/datadog/supervisord.log
2015-03-12 22:51:08,890 | INFO | dd.collector | flare(flare.py:172) |   * /etc/dd-agent/datadog.conf
2015-03-12 22:51:08,892 | INFO | dd.collector | flare(flare.py:183) |   * /etc/dd-agent/supervisor.conf
2015-03-12 22:51:08,907 | INFO | dd.collector | flare(flare.py:211) |   * /etc/dd-agent/conf.d/fluentd.yaml
2015-03-12 22:51:08,912 | INFO | dd.collector | flare(flare.py:211) |   * /etc/dd-agent/conf.d/jmx.yaml
2015-03-12 22:51:08,920 | INFO | dd.collector | flare(flare.py:211) |   * /etc/dd-agent/conf.d/activemq.yaml - this file contains a password which has been removed in the version collected
2015-03-12 22:51:08,924 | INFO | dd.collector | flare(flare.py:211) |   * /etc/dd-agent/conf.d/etcd.yaml
2015-03-12 22:51:08,927 | INFO | dd.collector | flare(flare.py:211) |   * /etc/dd-agent/conf.d/mysql.yaml - this file contains a password which has been removed in the version collected
2015-03-12 22:51:08,934 | INFO | dd.collector | flare(flare.py:211) |   * /etc/dd-agent/conf.d/consul.yaml
2015-03-12 22:51:08,936 | INFO | dd.collector | flare(flare.py:211) |   * /etc/dd-agent/conf.d/nginx.yaml
2015-03-12 22:51:08,939 | INFO | dd.collector | flare(flare.py:211) |   * /etc/dd-agent/conf.d/network.yaml
2015-03-12 22:51:08,940 | INFO | dd.collector | flare(flare.py:95) |   * datadog-agent configcheck output
2015-03-12 22:51:09,017 | INFO | dd.collector | flare(flare.py:97) |   * datadog-agent status output
2015-03-12 22:51:10,102 | INFO | dd.collector | flare(flare.py:99) |   * datadog-agent info output
2015-03-12 22:51:10,286 | INFO | dd.collector | flare(flare.py:102) | Saving all files to /tmp/datadog-agent-2015-03-12-22-51-06.tar.bz2
/tmp/datadog-agent-2015-03-12-22-51-06.tar.bz2 is going to be uploaded to Datadog.
Do you want to continue [Y/n]?
Please enter your email: *****@datadoghq.com
2015-03-12 22:51:19,913 | INFO | dd.collector | flare(flare.py:114) | Uploading /tmp/datadog-agent-2015-03-12-22-51-06.tar.bz2 to Datadog Support
2015-03-12 22:51:20,360 | INFO | dd.collector | flare(flare.py:300) | Your logs were successfully uploaded. For future reference, your internal case id is 666

Windows

  1. Select Flare from the Actions button's menu. flare_button
  2. When invited, enter your existing support case number (or leave the default value to create a new ticket).
  3. Please wait while Datadog agent is archiving logs and configurations (this usually takes about a dozen of seconds)
  4. When invited, enter the email address you use to sign in with Datadog.
  5. The archive is uploaded and attached to the existing ticket (or a new one). If the upload failed, please consider sending manually the final archive available in C:\Users\MYUSER\AppData\Local\Temp\datadog-agent-YYYY-MM-DD-hh-mm-ss.tar.bz2 (with YYYY-MM-DD-hh-mm-ss being the collection time).

windows_flare_final

What's collected?

Final content should be a compressed file: datadog-agent-YYYY-MM-DD-hh-mm-ss.tar.bz2 (with YYYY-MM-DD-hh-mm-ss being the collection time).

Once extracted, its content should be:

datadog-{hostname}
├── configcheck.log
├── etc
│   ├── conf.d
│   │   ├── agent_metrics.yaml.default
│   │   ├── disk.yaml.default
│   │   ├── elastic.yaml
│   │   ├── jmx.yaml
│   │   ├── network.yaml.default
│   │   ├── nginx.yaml
│   │   ├── ntp.yaml.default
│   │   └── zk.yaml
│   ├── datadog.conf
│   └── supervisor.conf
├── freeze.log
├── info.log
├── jmxinfo
│   ├── java_version.log
│   ├── jmx_status.yaml
│   ├── jmx_status_python.yaml
│   ├── list_everything.log
│   └── list_matching_attributes.log
├── log
│   ├── collector.log
│   ├── collector.log.1
│   ├── dogstatsd.log
│   ├── dogstatsd.log.1
│   ├── forwarder.log
│   ├── forwarder.log.1
│   ├── jmxfetch.log
│   ├── jmxfetch.log.1
│   └── supervisord.log
├── permissions.log
└── status.log

content based on Datadog agent 5.5.0

{hostname} is the hostname used by the agent.

Log directory (/log directory)

It contains all agent logs (including rotated logs), supervisord.log on Linux.

Configuration (/etc/dd-agent directory)

Comment lines are removed from all configurations.

etc
├── conf.d
│   ├── agent_metrics.yaml.default
│   ├── disk.yaml.default
│   ├── elastic.yaml
│   ├── jmx.yaml
│   ├── network.yaml.default
│   ├── nginx.yaml
│   ├── ntp.yaml.default
│   └── zk.yaml
├── datadog.conf
└── supervisor.conf

Only enabled checks configurations are collected, comment lines are removed and passwords are redacted with *********.

The api_key in datadog.conf is redacted with ************************abcde (abcde being the last 5 characters of the real api_key).

JMX information (/jmxinfo directory)*

*Since Datadog agent 5.5.0, only available when a JMX integration is set

jmxinfo
├── java_version.log
├── jmx_status.yaml
├── jmx_status_python.yaml
├── list_everything.log
└── list_matching_attributes.log

It contains:

  • Java version
  • JMXFetch status files (jmx_status_python.yaml is only present when a JMX integration is misconfigured)
  • JMXFetch list_everything and list_matching_attributes command ouputs. More information: http://docs.datadoghq.com/integrations/java/

Other files

datadog-{hostname}
├── configcheck.log
├── freeze.log
├── info.log
└── status.log

configcheck.log

Output of the configcheck of the agent, check that checks configuration files are YAML valid.

freeze.log

Output of pip freeze, versions of all libraries installed and used by the agent.

info.log

Output of the info of the agent (Version of the agent, status and checks enabled).

permissions.log*

*Since Datadog agent 5.5.0, only available on Unix systems

Unix permissions on collected files.

status.log

Output of the agent status and of supervisorctl status.

Getting the agent

Getting help

Agent design

Contributing

Clone this wiki locally