Puppet Class: datadog_agent::integrations::nginx

Inherits:
datadog_agent::params
Defined in:
manifests/integrations/nginx.pp

Overview

Class: datadog_agent::integrations::nginx

This class will install the necessary configuration for the nginx integration

See the sample nginx.d/conf.yaml for all available configuration options github.com/DataDog/integrations-core/blob/master/nginx/datadog_checks/nginx/data/conf.yaml.example

Parameters:

$instances:
    Array of hashes for all nginx urls and associates tags. See example
$logs:
    (optional) log collection configuration, in the format described here:
    https://docs.datadoghq.com/integrations/nginx/

Sample Usage:

class { 'datadog_agent::integrations::nginx':
  instances => [
      {
          'nginx_status_url'  => 'http://example.com/nginx_status/',
      },
      {
          'nginx_status_url'  => 'http://example2.com:1234/nginx_status/',
          'tags' => ['instance:foo'],
      },
  ],
  logs => [
      {
          'type' => 'file',
          'path' => '/var/log/nginx/access.log',
          'service' => 'nginx',
          'source' => 'nginx',
          'sourcecategory' => 'http_web_access'
        },
        {
          'type' => 'file',
          'path' => '/var/log/nginx/error.log',
          'service' => 'nginx',
          'source' => 'nginx',
          'sourcecategory' => 'http_web_access'
      },
  ],
}

Hiera Usage:

datadog_agent::integrations::nginx::instances:
    - nginx_status_url: 'http://example.com/nginx_status/'
    - nginx_status_url: 'http://example2.com:1234/nginx_status/'
      tags:
          - 'instance:foo'
datadog_agent::integrations::nginx::logs:
    - type: file
      path: /var/log/nginx/access.log
      service: nginx
      source: nginx
      sourcecategory: 'http_web_access'
    - type: file
      path: /var/log/nginx/error.log
      service: nginx
      source: nginx
      sourcecategory: 'http_web_access'

Parameters:

  • instances (Array) (defaults to: [])
  • logs (Optional[Array]) (defaults to: undef) 


64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'manifests/integrations/nginx.pp', line 64

class datadog_agent::integrations::nginx (
  Array $instances      = [],
  Optional[Array] $logs = undef,
) inherits datadog_agent::params {
  require datadog_agent

  $dst_dir = "${datadog_agent::params::conf_dir}/nginx.d"

  file { $dst_dir:
    ensure  => directory,
    owner   => $datadog_agent::dd_user,
    group   => $datadog_agent::params::dd_group,
    mode    => $datadog_agent::params::permissions_directory,
    require => Package[$datadog_agent::params::package_name],
    notify  => Service[$datadog_agent::params::service_name],
  }
  $dst = "${dst_dir}/conf.yaml"

  file { $dst:
    ensure  => file,
    owner   => $datadog_agent::dd_user,
    group   => $datadog_agent::params::dd_group,
    mode    => $datadog_agent::params::permissions_protected_file,
    content => template('datadog_agent/agent-conf.d/nginx.yaml.erb'),
    require => Package[$datadog_agent::params::package_name],
    notify  => Service[$datadog_agent::params::service_name],
  }
}