Dynatrace OneAgent module for puppet

Table of Contents

1. Module Description - What the module does and why it is useful
2. Setup - The basics of getting started with the Dynatrace OneAgent
   • What the Dynatrace OneAgent affects
   • Setup requirements
   • Beginning with the Dynatrace OneAgent
3. Usage - Configuration options and additional functionality
   • Most basic OneAgent installation using a SAAS tenant
   • OneAgent installation using a managed tenant with a specific version
   • Advanced configuration
   • Setting tags, metadata and custom hostname
4. Reference - An under-the-hood peek at what the module is doing and how
5. Limitations - OS compatibility, etc.
6. Development - Guide for contributing to the module

Module description

This module deploys the Dynatrace OneAgent on Linux, Windows and AIX Operating Systems with different available configurations and ensures the OneAgent service maintains a running state. It provides the resource types to interact with the various OneAgent configuration files.

Setup

What the Dynatrace OneAgent affects

• Installs the Dynatrace OneAgent package with the selected parameters and manages its config files.
• By default, enables the Dynatrace OneAgent boot-start, and uses the generated service file as part of the installer to manage the Dynatrace OneAgent service.
• Any running processes prior to installing the OneAgent package will need to be restarted for full instrumentation, a server reboot is another alternative.

Setup requirements

This module requires puppet/archive as well as puppet-labs/reboot for Windows restarts.

To begin using this module, use the Puppet Module Tool (PMT) from the command line to install this module:

puppet module install dynatrace-dynatraceoneagent

You will then need to supply the dynatraceoneagent class with two critical pieces of information.

• The tenant URL: Managed https://{your-domain}/e/{your-environment-id} | SaaS https://{your-environment-id}.live.dynatrace.com
• The PaaS token of your environment for downloading the OneAgent installer

Refer to the customize OneAgent installation documentation on Dynatrace Supported Operating Systems This module uses the Dynatrace deployment API for downloading the installer for each supported OS. See Deployment API

Beginning with the Dynatrace OneAgent

Once the Dynatrace OneAgent packages are downloaded to the target hosts using the archive module, the module is ready to deploy.

Usage

Default OneAgent install parameters defined in params.pp as a hash map: INFRA_ONLY=0, APP_LOG_CONTENT_ACCESS=1

Most basic OneAgent installation using a SAAS tenant

    class { 'dynatraceoneagent':
        tenant_url  => 'https://{your-environment-id}.live.dynatrace.com',
        paas_token  => '{your-paas-token}',
    }

OneAgent installation using a managed tenant with a specific version

The required version of the OneAgent must be in 1.155.275.20181112-084458 format. See Deployment API - GET available versions of OneAgent

    class { 'dynatraceoneagent':
        tenant_url  => 'https://{your-domain}/e/{your-environment-id}',
        paas_token  => '{your-paas-token}',
        version     => '1.181.63.20191105-161318',
    }

Advanced configuration

Download OneAgent installer to a custom directory with additional OneAgent install parameters and reboot server after install should be defined as follows (will override default install params):

    class { 'dynatraceoneagent':
        tenant_url            => 'https://{your-environment-id}.live.dynatrace.com',
        paas_token            => '{your-paas-token}',
        version               => '1.181.63.20191105-161318',
        download_dir          => 'C:\\Download Dir\\',
        reboot_system         => true,
        oneagent_params_hash  => {
            'INFRA_ONLY'             => '0',
            'APP_LOG_CONTENT_ACCESS' => '1',
            'HOST_GROUP'             => 'PUPPET_WINDOWS',
            'INSTALL_PATH'           => 'C:\Test Directory',
        }
    }

For Windows, because download_dir is a string variable, 2 backslashes are required Since the OneAgent install parameter INSTALL_PATH can be defined within a hash map, no escaping is needed for Windows file paths For further information on how to handle file paths on Windows, visit Handling file paths on Windows

Setting tags, metadata and custom hostname

Configure values to automatically add tags and metadata to a host and override an automatically detected host name, the values should contain a list of strings or key/value pairs. Spaces are used to separate tag and metadata values.

    class { 'dynatraceoneagent':
        tenant_url       => 'https://{your-domain}/e/{your-environment-id}',
        paas_token       => '{your-paas-token}',
        host_tags        => 'TestHost Gdansk role=fallback',
        host_metadata    => 'Environment=Prod Organization=D1P [email protected] Support=https://www.dynatrace.com/support',
        hostname         => 'apache-vm.puppet.vm',
        }
    }

Reference

Seen in file REFERENCE.md

Limitations

TBD

Development

TBD