AppDynamics Alerting Extension for use with Atlassian JIRA

This extension works only with a dedicated SaaS controller or an on-prem controller.

Use Case

JIRA from Atlassian, Inc. is a bug and issue tracking product used for project management. AppDynamics integrates directly with Atlassian JIRA to create JIRA tickets in response to AppDynamics alerts. With the Atlassian JIRA extension you can leverage your existing ticketing infrastructure to notify the operations team and resolve performance degradation issues.

Installation

  1. Download and unzip jira-alert.zip

  2. Copy the jira-alert directory into <CONTROLLER_HOME_DIR>/custom/actions/.

  3. Check if you have custom.xml file in <CONTROLLER_HOME_DIR>/custom/actions/ directory. If yes, add the following xml to the element.

          <action>
                  <type>jira-alert</type>
              <!-- For Linux/Unix *.sh -->
                  <executable>jira-alert.sh</executable>
              <!-- For windows *.bat -->
                  <!--<executable>jira-alert.bat</executable>-->
          </action>
    

    If you don't have custom.xml already, create one with the below xml content

          <custom-actions>
             <action>
                <type>jira-alert</type>
                <!-- For Linux/Unix *.sh -->
                <executable>jira-alert.sh</executable>
                <!-- For windows *.bat -->
               <!--<executable>jira-alert.bat</executable>-->
             </action>
          </custom-actions>
    

    Uncomment the appropriate executable tag based on windows or linux/unix machine.

  4. Update the config.yml file in <CONTROLLER_HOME_DIR>/custom/actions/jira-alert/conf/ directory with the required parameters. Please make sure to not use tab (\t) while editing yaml files. You may want to validate the yaml file using a yaml validator http://yamllint.com/

      domain: "https://sampledomain.atlassian.net"
      username: "<USER>"
      password: "<PASSWORD>"
      #encryptedPassword: ""
      projectKey: "PROJECT_KEY"
      #Optional, if empty logged as Bug
      issueType: "Bug"
      #encryptionKey: ""
      #http timeouts
      connectTimeout: 10000
      socketTimeout: 10000
      #proxy details
      proxy:
       uri: ""
       username: ""
       password: ""
       #encryptedPassword: ""
    
  5. Please refer to the following doc to create Custom Actions

    • Creating custom action
      Now you are ready to use this extension as a custom action. In the AppDynamics UI, go to Alert & Respond -> Actions. Click Create Action. Select Custom Action and click OK. In the drop-down menu you can find the action called 'jira-alert'.

    A policy has to be associated with this action for it to be triggered. Refer the docs below

  6. Look for the newest created issue in Jira.. Sample screenshot of the issue is here

Password Encryption Support

To avoid setting the clear text password in the config.yml, please follow the process to encrypt the password. Then set encryptionKey and generated password for encryptedPassword in config.yml

  1. Download the util jar to encrypt the password from here
  2. Encrypt password from the commandline
    java -cp "appd-exts-commons-1.1.2.jar" com.appdynamics.extensions.crypto.Encryptor encryptionKey myPassword
  3. These values should be used in the encryptedPassword and encryptionKey fields in config.yml

Contributing

Always feel free to fork and contribute any changes directly via GitHub

Support

For any questions or feature request, please contact AppDynamics Support

Version:

2.0

Controller Compatibility:

4.2+

Java Compatibility:

1.8

Last Update:

09/23/2016
Attachments: