Skip to content

Latest commit

 

History

History
79 lines (64 loc) · 4.05 KB

framework-introscope_agent.md

File metadata and controls

79 lines (64 loc) · 4.05 KB
Raw

CA Introscope APM Framework

The CA Introscope APM Framework causes an application to be automatically configured to work with a bound Introscope service.

Detection CriterionExistence of a single bound Introscope service.
  • Existence of a Introscope service is defined as the VCAP_SERVICES payload containing a service who's name, label or tag has introscope as a substring.
Tags introscope-agent=<version>
Tags are printed to standard output by the buildpack detect script

User-Provided Service (Optional)

Users may optionally provide their own Introscope service. A user-provided Introscope service must have a name or tag with introscope in it so that the Introscope Agent Framework will automatically configure the application to work with the service.

The credential payload of the service may contain any valid CA APM Java agent property.

The table below displays a subset of properties that are accepted by the buildpack. Please refer to CA APM docs for a full list of valid agent properties.

Name Description
agent_manager_credential (Optional) The credential that is used to connect to the Enterprise Manager server.
agentManager_url_1 The url of the Enterprise Manager server.
agent_manager_url (Deprecated) The url of the Enterprise Manager server.
credential (Deprecated) The credential that is used to connect to the Enterprise Manager server

To provide more complex values such as the agent_name, using the interactive mode when creating a user-provided service will manage the character escaping automatically. For example, the default agent_name could be set with a value of agent-$(expr "$VCAP_APPLICATION" : '.*application_name[": ]*\([[:word:]]*\).*') to calculate a value from the Cloud Foundry application name.

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/introscope_agent.yml][] file in the buildpack fork. The framework uses the Repository utility support and so it supports the version syntax defined there.

Name Description
repository_root The URL of the Introscope Agent repository index (details).
version The version of Introscope Agent to use.

Additional Resources

The framework can also be configured by overlaying a set of resources on the default distribution. To do this, add files to the resources/introscope_agent directory in the buildpack fork.

Example for 10.x
resources/
    |-introscope_agent/
          |-core/
              |-config/
                   |-IntroscopeAgent.profile                 # place custom Introscope Profile under the config folder
                   |-hotdeploy/                              # place custom pbd files under the hotdeploy folder
                         |-example.pbd
Example for 11.1.x
resources/
    |-introscope_agent/
            |-releases/
                 |-11.1/
                     |-core/
                         |-config/
                              |-IntroscopeAgent.profile     # place custom Introscope Profile under the config folder
                              |-hotdeploy/                  # place custom pbd files under the hotdeploy folder
                                     |-example.pbd