Enabling and configuring Automation Action GitLab sensor

You can integrate Instana with a GitLab repository for managing automation scripts with the Automation Action GitLab sensor. The sensor is automatically deployed and installed with the Instana agent. After you enable the sensor, you can export the scripts generated with watsonx to a GitLab project. To run these scripts, also enable the Automation Action Script sensor.

Prerequisites

Before you enable this sensor, complete the following steps:

  1. Review the information in Securely using the automation framework.
  2. If the sensor is used in a self-hosted (on-premises) environment, ensure that the automation feature flag is enabled.

Enabling the sensor

The Automation Action GitLab sensor is disabled by default. To enable the sensor, update the agent configuration file as shown in the following example:

com.instana.plugin.action.gitlab:
  enabled: true # by default is false
  baseUrl: <gitlab_api_url> # i.e. https://gitlab.ibm.com/api/v4
  accessToken:
    configuration_from:
      type: vault
      secret_key:
        path: <secret_path>
        key: <secret_key>

Use the vault' parameter for accessTokenas shown in the preceding example to secure your access token. For more information on usingvault`, see How to protect sensitive data when you use the automation framework. Avoid using plain text tokens as they are insecure.

The following example shows the use of plain text token in the configuration and is for reference purpose only.

com.instana.plugin.action.gitlab:
  enabled: true # by default is false
  baseUrl: <gitlab_api_url> # i.e. https://gitlab.ibm.com/api/v4
  accessToken: <gitlab_access_token>

Configuring default timeout

By default, a GitLab operation times out after 10 seconds. If you want to change the default timeout, add the defaultTimeout attribute to the sensor configuration section in the agent configuration file as follows:

com.instana.plugin.action.gitlab:
  enabled: true
  defaultTimeout: 30 # optional, default timeout is 10 seconds