dynatraceoneagent
Version information
This version is compatible with:
- Puppet Enterprise 2019.8.x, 2019.7.x, 2019.5.x, 2019.4.x, 2019.3.x, 2019.2.x, 2019.1.x, 2019.0.x, 2018.1.x, 2017.3.x, 2017.2.x, 2016.4.x
- Puppet >= 4.10.0 < 7.0.0
- , , , , , , , ,
Start using this module
Add this module to your Puppetfile:
mod 'dynatrace-dynatraceoneagent', '1.2.0'Learn more about managing modules with a PuppetfileDocumentation
Dynatrace OneAgent module for puppet
Table of Contents
- Module Description - What the module does and why it is useful
- Setup - The basics of getting started with the Dynatrace OneAgent
- Usage - Configuration options and additional functionality
- Reference - An under-the-hood peek at what the module is doing and how
- Limitations - OS compatibility, etc.
- 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}| SaaShttps://{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 Owner=john.doe@dynatrace.com Support=https://www.dynatrace.com/support',
hostname => 'apache-vm.puppet.vm',
}
}
Reference
Seen in file REFERENCE.md
Limitations
TBD
Development
TBD
Reference
Classes
Public Classes
dynatraceoneagent: Install and configure the Dynatrace OneAgent.
Private classes
dynatraceoneagent::configure: Handles the configuration of the Dynatrace OneAgent.dynatraceoneagent::install: Handles the Dynatrace Oneagent installation.dynatraceoneagent::service: Handles the Dynatrace Oneagent service.
Parameters
The following parameters are available in the dynatraceoneagent class.
tenant_url - required
Data Type: String
URL of your dynatrace Tenant
- Managed:
https://{your-domain}/e/{your-environment-id} - SaaS:
https://{your-environment-id}.live.dynatrace.com
Default value: undef
paas_token - required
Data Type: String
PAAS token for downloading one agent installer
Default value: undef
version - optional
Data Type: String
The required version of the OneAgent in 1.155.275.20181112-084458 format
Default value: latest
arch - optional
Data Type: String
The architecture of your OS
Default value: all
installer_type - optional
Data Type: String
The type of the installer
Default value: default
proxy_server - optional
Data Type: String
Proxy server to be used by the archive module for downloading the OneAgent installer if needed
Default value: undef
download_dir - optional
Data Type: String
OneAgent installer file download directory.
Defaults values are:
- Linux/AIX :
/tmp/ - Windows :
C:\\Windows\\Temp\\
oneagent_params_hash - optional
Data Type: Hash
Hash map of additional parameters to pass to the installer
Default OneAgent install parameters defined in params.pp as a hash map.
Default values are:
INFRA_ONLY => 0APP_LOG_CONTENT_ACCESS => 1
reboot_system - optional
Data Type: Boolean
If set to true, puppet will reboot the server after installing the OneAgent
Default: false
host_tags - optional
Data Type: String
Values to automatically add tags to a host, should contain a list of strings or key/value pairs. Spaces are used to separate tag values.
Default value: undef
host_metadata - optional
Data Type: String
Values to automatically add metadata to a host, should contain a list of strings or key/value pairs. Spaces are used to separate metadata values.
Default value: undef
hostname - optional
Data Type: String
Overrides an automatically detected host name.
Default value: undef
Changelog
All notable changes to this project will be documented in this file.
Release 1.2.0
Features
- Add proxy server resource for archive module
Bugfixes
TBD
Known Issues
TBD
Release 1.1.0
Features
TBD
Bugfixes
- Fix config directory dependency issue by installing OneAgent package in install.pp
Known Issues
TBD
Release 1.0.0
Features
- Ability to set string values to the hostcustomproperties.conf and hostautotag.conf of the OneAgent config to add tags and metadata to a host entity.
- Ability to override the automatically detected hostname by setting the values of the hostname.conf file and restarting the Dynatrace OneAgent service.
Bugfixes
- Remove debug message for whenever reboot parameter was set to false
Known Issues
TBD
Release 0.5.0
Features
- Ability to download specific version
- Module will automatically detect OS and download required installer
- Module will automatically detect OS and will run the installer package required
- Add AIX support
- Add support for OneAgent Install Params
- Implement Archive module for OneAgent installer downloads
- Reboot functionality included
- Module built and validated with PDK
Bugfixes
- Fix OneAgent download issue
- Fix module directory issue
Known Issues
TBD
MIT License Copyright (c) 2008-2019 Dynatrace LLC Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.