Skip to content

Files

Latest commit

 

History

History
 
 

octoprint

README.md

Agent Check: OctoPrint

Overview

This check monitors OctoPrint through the Datadog Agent.

Setup

Follow the instructions below to install and configure this check for an Agent running on a host. For containerized environments, see the Autodiscovery Integration Templates for guidance on applying these instructions.

Installation

To install the OctoPrint check on your host by running:

sudo -u dd-agent -- datadog-agent integration install datadog-octoprint==<VERSION>

Note: The VERSION is listed at the top of this page.

Install from source (optional)

  1. Install the developer toolkit on any machine.

  2. Run ddev release build octoprint to build the package.

  3. Download the Datadog Agent.

  4. Upload the build artifact to any host with an Agent and run datadog-agent integration install -w path/to/octoprint/dist/datadog_octoprint*.whl.

Configuration

  1. From the OctoPrint web interface, create an API key for use with Datadog. This can be found within Settings --> Application Keys.

  2. Edit the octoprint.d/conf.yaml file, in the conf.d/ folder at the root of your Agent's configuration directory. Paste the OctoPrint API key as the value for octo_api_key. See the sample octoprint.d/conf.yaml for all available configuration options.

  3. Restart the Agent.

Validation

Run the Agent's status subcommand and look for octoprint under the Checks section.

Logs

By default this integration assumes that you are using the OctoPi image that is pre-configured to run OctoPrint from a Raspberry Pi.

The logs that it collects by default (and their default locations) are:

  • OctoPrint App log: /home/pi/.octoprint/logs
  • OctoPrint Webcam log: /var/log/webcamd.log
  • HA Proxy log: /var/log/haproxy.log

Any or all of these may be changed or removed by modifying the integration's conf.yaml file.

Log processing

OctoPrint uses its own log format (not an object format). To make use of the logs, create a log processing pipeline with some parsing rules, for example:

  1. Main Pipeline: "OctoPrint"
    1. Sub Pipeline 1: "OctoPrint Print Job"
      1. Grok parser rule:
        • OctoPrint_Print_Job %{date("yyyy-MM-dd HH:mm:ss,SSS"):date}\s+-\s+%{notSpace:source}\s+-\s+%{word:level}\s+-\s+Print\s+job\s+%{notSpace:job_status}\s+-\s+%{data::keyvalue(":"," ,")}
    2. Sub Pipeline 2: "General OctoPrint Log"
      1. Grok parser rule:
        • General_OctoPrint_Log %{date("yyyy-MM-dd HH:mm:ss,SSS"):date}\s+-\s+%{notSpace:source}\s+-\s+%{word:level}\s+-\s+%{data:message}

For more information, see the Datadog Log Processing documentation.

Data Collected

Metrics

See metadata.csv for a list of metrics provided by this integration.

Events

OctoPrint does not include any events.

Service Checks

See service_checks.json for a list of service checks provided by this integration.

Troubleshooting

Need help? Contact Datadog support.