Forge Home

apmserver

Install and manage Elastic's APM server

16,396 downloads

664 latest version

5.0 quality score

We run a couple of automated
scans to help you access a
module's quality. Each module is
given a score based on how well
the author has formatted their
code and documentation and
modules are also checked for
malware using VirusTotal.

Please note, the information below
is for guidance only and neither of
these methods should be considered
an endorsement by Puppet.

Version information

  • 1.1.2 (latest)
  • 1.1.1
  • 1.1.0
  • 1.0.7
  • 1.0.6
  • 1.0.5
  • 1.0.3
  • 1.0.2
  • 1.0.1
  • 1.0.0 (deleted)
released Sep 22nd 2021
This version is compatible with:
  • Puppet Enterprise 2021.7.x, 2021.6.x, 2021.5.x, 2021.4.x, 2021.3.x, 2021.2.x, 2021.1.x, 2021.0.x, 2019.8.x, 2019.7.x, 2019.5.x, 2019.4.x, 2019.3.x, 2019.2.x, 2019.1.x
  • Puppet >= 6.1.0 < 8.0.0
  • , , , , ,

Start using this module

  • r10k or Code Manager
  • Bolt
  • Manual installation
  • Direct download

Add this module to your Puppetfile:

mod 'kobybr-apmserver', '1.1.2'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add kobybr-apmserver
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install kobybr-apmserver --version 1.1.2

Direct download is not typically how you would use a Puppet module to manage your infrastructure, but you may want to download the module in order to inspect the code.

Download

Documentation

kobybr/apmserver — version 1.1.2 Sep 22nd 2021

Elastic APM server

Build Status Puppet Forge Puppet Forge Downloads Puppet Forge Score Puppet Forge Endorsement GitHub last commit

Usage

To install and manage the apm-server with all default settings:

include '::apmserver'

To install and manage the apm-server with custom settings:

$apmserver_config_custom = {
  'apm-server' => { 'host' => "${::ipaddress}:8200" },
  'output.elasticsearch' => {
    'hosts' => [ '192.168.1.1:9200', '192.168.1.2:9200' ],
    'enabled' => true,
  },
}

class {'::apmserver':
  apmserver_config_custom => $apmserver_config_custom,
}

Example hiera YAML file:

---
apmserver::custom_config:
  apm-server:
    host: 10.1.1.1:8200
  output.elasticsearch:
    hosts:
    - 192.168.1.1:9200
    - 192.168.1.2:9200
    enabled: true
class {'::apmserver':
  apmserver_config_custom => hiera_hash('apmserver::custom_config', {}),
}

Module Parameters

manage_repo Enable repo management by enabling official Elastic repositories.

repo_version The version to be used with elastic_stack for setting repository version.

merge_default_config Merge config settings from the apm-server.yml file provided in the rpm. Default: true

package_ensure Control if the managed package shall be present or absent

package_version To set the specific version you want to install (ex. 6.5.4). Default: latest

package_name Name of the package to install. Default: apm-server

package_config_path Path to the directory in which to install configuration files. Default: '/etc/apm-server'

service_ensure Whether the service should be running. Default: running

service_enable Whether the service should be enabled to start at boot. Default: true

service_name Name of service to manage. Default: apm-server

apmserver_config_custom Custom configuration settings. Default: {}

apmserver_default_config_file Full path to the packages default configuration file. Default: undef

config_owner Parameter to set the owner of the configuration file. Default: undef

config_group Parameter to set the group of the configuration file. Default: undef