Skip to content

Latest commit

 

History

History
65 lines (50 loc) · 3.14 KB

framework-takipi_agent.md

File metadata and controls

65 lines (50 loc) · 3.14 KB

Takipi Agent Framework

The Takipi Agent Framework causes an application to be automatically configured to work with OverOps Service.

Detection CriterionExistence of a single bound Takipi service. The existence of an Takipi service defined by the VCAP_SERVICES payload containing a service name, label or tag with app-dynamics or takipi as a substring.
Tagstakipi-agent=<version>
Tags are printed to standard output by the buildpack detect script

User-Provided Service

When binding Takipi using a user-provided service, it must have name or tag with takipi in it. The credential payload can contain the following entries.

Name Description
collector_host The remote collector hostname or IP
collector_port the remote collector port (TCP)
secret_key (DEPRECATED) The agent installation key for running collector alongside agent

Setting collector_host and collector_port will connect to a remote collector. More information can be found in OverOps Remote Collector

(DEPRECATED)Setting secret_key will run a local collector alongside the agent.

Configuration

For general information on configuring the buildpack, including how to specify configuration values through environment variables, refer to Configuration and Extension.

The framework can be configured by modifying the config/takipi_agent.yml file. The framework uses the Repository utility support and so it supports the version syntax defined there.

Name Description
node_name_prefix Node name prefix, will be concatenated with - and instance index
application_name Override the CloudFoundry default application name

Remarks

In case Java 9+ is being used, 2 JVM flags will be added to the execution:

Name Description
-XX:-UseTypeSpeculation Disable type speculation optimization of the JVM which might not work properly in some situations where an agent is present.
-Xshare:off Disable class sharing as it might affect the agent's bytecode manipulation work.

These two flags are needs as otherwise the agent or the JVM might not work properly together.

Logs

Currently, you can view the Takipi agent logs using the cf ssh command:

cf ssh app_name 
cat ~/app/.java-buildpack/takipi_agent/log/agents/*.log

Troubleshooting

If your container is running out of memory and exited with status 137, then you should setup and use a remote collector as explained in the User-Provided Service above section.