Skip to content

Latest commit

 

History

History
330 lines (170 loc) · 4.75 KB

REFERENCE.md

File metadata and controls

330 lines (170 loc) · 4.75 KB
Raw

Reference

Table of Contents

Classes

Public Classes

Private Classes

  • instana_agent::config: Agent configuration
  • instana_agent::install: Install repositories, keys and the agent package
  • instana_agent::required_config: Additional configuration for the agent
  • instana_agent::service: Configure and start the agent service

Data types

Classes

instana_agent

Install and configure the Instana agent

Examples

Basic usage
class { 'instana_agent':
  key => '<key>',
}

Parameters

The following parameters are available in the instana_agent class.

key

Data type: String

Instana license key

service_ensure

Data type: Stdlib::Ensure::Service

Set the instana-agent service status

Default value: 'running'

service_enable

Data type: Boolean

Enable or disable the instana-agent service

Default value: true

endpoint_host

Data type: String

Url of the Instana endpoint host

Default value: 'saas-us-west-2.instana.io'

endpoint_port

Data type: Stdlib::Port

Port of the endpoint host

Default value: 443

flavor

Data type: Enum['dynamic','static']

Agent flavor For more information see https://docs.instana.io/quick_start/agent_automation/#flavors

Default value: 'static'

mode

Data type: String

Agent mode

Default value: 'APM'

tags

Data type: Array[String]

Agent tags

Default value: []

zone

Data type: String

Availability zone

Default value: ''

update_pin

Data type: String

The update PIN

Default value: ''

update_enabled

Data type: Boolean

Whether to do automatic updates of the agent

Default value: true

update_interval

Data type: Instana_agent::Every

How often updates should be done

Default value: 'DAY'

update_time

Data type: String

Time of day where the updates should be done

Default value: '04:30'

cpu_limited

Data type: Boolean

Whether to set a cpu limit for the agent process

Default value: true

cpu_quota

Data type: Float

Set the CPU quota for the agent process if limiting is enabled

Default value: 0.5

memory_limited

Data type: Boolean

Whether to set a memory limit for the agent process

Default value: true

memory_quota

Data type: Numeric

Maximum amount of memory in MiB to use for the agent if limiting is enabled

Default value: 512

proxy_enabled

Data type: Boolean

Whether to enable the proxy

Default value: false

proxy_type

Data type: Enum['http', 'socks4', 'socks5']

The type of proxy to use

Default value: 'http'

proxy_host

Data type: String

Url to the proxy server

Default value: ''

proxy_port

Data type: Numeric

Port of the proxy server

Default value: 3128

proxy_dns

Data type: Boolean

If set to true, no local DNS resolution is attempted

Default value: true

proxy_username

Data type: String

Username for the proxy service

Default value: ''

proxy_password

Data type: String

Password for the proxy service

Default value: ''

mirror_enabled

Data type: Boolean

Whether a local maven mirror should be used

Default value: false

mirror_auth_enabled

Data type: Boolean

Whether authentication is required for the mirror

Default value: false

mirror_auth_username

Data type: String

Username for the maven mirror

Default value: ''

mirror_auth_password

Data type: String

Password for the maven mirror

Default value: ''

mirror_urls_release

Data type: String

Url for the release mirror

Default value: ''

mirror_urls_shared

Data type: String

Url for the shared mirror

Default value: ''

manage_repository

Data type: Boolean

Enable and disable repository management

Default value: true

scheduler_threads

Data type: Integer

Number of scheduler threads to use

Default value: 4

http_threads

Data type: Integer

Number of http threads to use

Default value: 4

use_cloud_provider_id

Data type: Boolean

Whether to use the id of the cloud provider

Default value: true

ignore_processes

Data type: Optional[Hash[String,Array]]

Disable monitoring for processes or arguments of processes For more information see https://www.instana.com/docs/setup_and_manage/host_agent/configuration#ignore-processes

Default value: undef

Data types

Instana_agent::Every

Instana time interval

Alias of Enum['DAY', 'MONDAY', 'TUESDAY', 'WEDNESDAY', 'THURSDAY', 'FRIDAY', 'SATURDAY', 'SUNDAY']