Install a Multi-Environment Collector for Java

Introduction

The need to scale for hundreds of applications, thousands of environments, and tens of functional groups has led to the development of OverOps Multi-Environment Collector (MEC), which enables you to on-board new applications and functional groups in an easy and repeatable way.

📘

Note

If you wish to deploy MEC in your organization, contact an OverOps representative.

Why Deploy MEC?

If your organization is running multiple applications, using a single environment collector means that for each new environment, you'll need to add load balancers and a new collector. Deploying agents to a single collector means:

  • A complex installation
  • Significant effort for the operations team
  • Increased cost for machines

MEC creates a centralized management solution that ensures easy installation and addition of new applications and environments.

🚧

Important

Whereas in previous installations you didn't need to specify the environment for the Agent (because the Agent and Collector already made this correlation), for the MEC, you'll need to define the environment ID -Dtakipi.env.id=S1

Prerequisites for Installing MEC

1. Installation Token

The MEC installation uses a new kind of authentication that utilizes an installation token (an installation.token file) rather than an installation.key for the Collector. The installation token is created automatically when an installation key is created - or when a user signs up for OverOps. If you're a SaaS user, contact your OverOps representative to have them create a token for you.

For On-Premises deployments, super admin users can also use the admin-cli command to generate an installation token. Use the following syntax to create the token:

`/opt/takipi-server/bin/takipi-server.sh admin-cli install_token <username> <main_env_id> "list of services"

Note that the services should be added between quotation marks and separated by semicolons without spaces, for example:

/opt/takipi-server/bin/takipi-server.sh admin-cli install_token [email protected] S2 "S2;S3;S4"

2. Collector Port

OverOps uses Port 6060 as the default port.

📘

Note

Port 6060 will be used by default as the port that the Collector will be listening on.
If you're using a Collector port other than 6060, please add --listen_port=<COLLECTOR_PORT> to the end of the installation command.

Verifying the Installation

Verify that the takipi-service is running:
ps -ef | grep takipi

Attaching the OverOps Java Micro-Agent to the MEC

  1. To attach each Micro-Agent, add the environment ID flag -Dtakipi.env.id=<Environment_ID> to the agentlib:TakipiAgent argument.
    For example: `-Dtakipi.env.id=S2 where S2 is the default environment ID for the -agentlib:TakipiAgent argument. The Micro-Agent will then pass a -Dtakipi.env.id=S2 argument for the Collector to utilize in that environment.
  2. Follow the instructions for installing a Java Micro-Agent and then attaching the Java Micro-Agent.

🚧

Important

Remember to restart the Collector(s)

  • after creating the MEC token initially and converting the Collector to MEC (upload/create the installation.token file on the collector)
  • whenever the token is being updated afterwards.