Agent Automation

We support a variety of configuration management tools to help you with automating the agent installation. Currently we provide scripts for Ansible, Chef and Puppet. All configuration management scripts are regularly published to the corresponding official registries.

General

The following information applies to all configuration management tools.

Requirements

The required settings can be acquired from our sales team. They consist of an identifying key and an address:

  • The Agent key: This serves as a tenancy identifier across the platform;
  • The monitoring endpoint address: This serves as a tenancy identifier across the platform;
  • The monitoring endpoint port: This is the port where the agent will send its packets to.

Flavors

instana-agent-dynamic

This blank agent comes bundled with a JDK and is configured to download all neccessary sensors when it starts. Additionally, it is configured to update its set of sensors on a daily basis.

instana-agent-static

This “gated” agent package is supposed to not connect to the internet at all. It comes with all the recent sensors and a JDK, and is your package of choice when you run a tight firewall setup.

Monitoring endpoint

If you are an onprem customer, please specify your hostname and port in the corresponding attributes. If you are using our SaaS offering, and do not know which endpoint the agent should send to, feel free to ask our sales team.

Ansible Galaxy

The Ansible role installs, configures and runs the monitoring agent for the Instana monitoring suite. You can find the role in the Ansible Galaxy at https://galaxy.ansible.com/instana/instana-agent-ansible.

To install the role use $ ansible-galaxy install instana.instana-agent-ansible.

Here is an example of a playbook with the various configuration options:

---
  - hosts: all
    become: yes
    roles:
      - instana.instana-agent-ansible
    vars:
      instana_agent_flavor: "dynamic"
      instana_agent_jdk: "/opt/jdk"
      instana_agent_updates_enabled: yes
      instana_agent_updates_interval: "DAY"
      instana_agent_updates_time: "04:30"
      instana_agent_zone: "prod"
      instana_agent_agent_key: <YOUR_INSTANA_AGENT_KEY>
      instana_agent_endpoint_host: <YOUR_INSTANA_REGION_ENDPOINT:saas-us-west-2.instana.io>
      instana_agent_endpoint_port: 443

Chef cookbook

The Chef cookbook installs, configures and runs the monitoring agent for the Instana monitoring suite. You can find the cookbook in the Chef supermarket at https://supermarket.chef.io/cookbooks/instana-agent.

To download the cookbook use $ knife cookbook site download instana-agent.

Some attributes may be loaded via a chef databag: instana-agent, item: general

{
	"id": "general",
	"flavor": "static",
	"key": "<YOUR_INSTANA_AGENT_KEY>",
	"endpoint_host": "<YOUR_INSTANA_REGION_ENDPOINT:saas-us-west-2.instana.io>",
	"endpoint_port": 443,
	"mode": "apm",
	"zone": "production",
	"tags": ["tag", "another"]
}

Puppet Forge

The Puppet module installs, configures and runs the monitoring agent for the Instana monitoring suite. You can find the module in the Puppet Forge at https://forge.puppet.com/instana/agent.

To install the module use $ puppet module install instana-agent.

They attributes completely match the ones in our Chef cookbook.