AWS Kinesis Firehose Monitoring Extension

AWS Kinesis Data Firehose Monitoring Extension

Use Case

Captures statistics for Amazon Kinesis Data Firehose from Amazon CloudWatch and displays them in the AppDynamics Metric Browser.

Prerequisites

  1. Please give the following permissions to the account being used to with the extension.
    cloudwatch:ListMetrics
    cloudwatch:GetMetricStatistics
    
  2. In order to use this extension, you do need a Standalone JAVA Machine Agent or SIM Agent. For more details on downloading these products, please visit here.
  3. The extension needs to be able to connect to AWS Cloudwatch in order to collect and send metrics. To do this, you will have to either establish a remote connection in between the extension and the product using access key and secret key, or have an agent running on EC2 instance, which you can use with instance profile.

Installation

  1. Run mvn clean install from aws-kinesis-datafirehose-monitoring-extension
  2. Copy and unzip AWSKinesisDataFirehoseMonitor-<version>.zip from target directory into <machine_agent_dir>/monitors/
  3. Edit config.yml file in AWSKinesisDataFirehoseMonitor and provide the required configuration (see Configuration section).
  4. Restart the Machine Agent.
    Please place the extension in the "monitors" directory of your Machine Agent installation directory. Do not place the extension in the "extensions" directory of your Machine Agent installation directory.

Configuration

In order to use the extension, you need to update the config.yml file that is present in the extension folder. The following is a step-by-step explanation of the configurable fields that are present in the config.yml file.

  1. If SIM is enabled, then use the following metricPrefix -

    metricPrefix: "Custom Metrics|AWS Kinesis Data Firehose|"

    Else, configure the "COMPONENT_ID" under which the metrics need to be reported. This can be done by changing the value of <COMPONENT_ID> in
    metricPrefix: "Server|Component:<COMPONENT_ID>|Custom Metrics|AWS Kinesis Data Firehose|".

    For example,

    metricPrefix: "Server|Component:100|Custom Metrics|AWS Kinesis Data Firehose|"
    
  2. Provide accessKey(required) and secretKey(required) of your account(s), also provide displayAccountName(any name that represents your account) and
    regions(required). If you are running this extension inside an EC2 instance which has IAM profile configured then you don’t have to configure accessKey and secretKey values, extension will use IAM profile to authenticate. You can provide multiple accounts and regions as below -

    accounts:
      - awsAccessKey: "XXXXXXXX1"
        awsSecretKey: "XXXXXXXXXX1"
        displayAccountName: "TestAccount_1"
        regions: ["us-east-1","us-west-1","us-west-2"]
    
      - awsAccessKey: "XXXXXXXX2"
        awsSecretKey: "XXXXXXXXXX2"
        displayAccountName: "TestAccount_2"
        regions: ["eu-central-1","eu-west-1"]
    
  3. If you want to encrypt the awsAccessKey and awsSecretKey then follow the “Credentials Encryption” section and provide the encrypted values in awsAccessKey and awsSecretKey. Configure enableDecryption of credentialsDecryptionConfig to true and provide the encryption key in encryptionKey.
    For example,

    #Encryption key for Encrypted password.
    credentialsDecryptionConfig:
        enableDecryption: "true"
        encryptionKey: "XXXXXXXX"
    
  4. To report metrics only from specific dimension values, configure the dimesion section. Dimension for Kinesis Data Firehose is DeliveryStreamName. For example to report metrics only from DeliveryStreamName dimension with value Sample, configure dimensions as below -

    dimensions:
      - name: "DeliveryStreamName"
        displayName: "DeliveryStreamName"
        values: ["Sample"]
    

    If .* is used, all dimension values are monitored and if empty, none are monitored.

  5. Configure the metrics section.

    For configuring the metrics, the following properties can be used:

    PropertyDefault valuePossible valuesDescription
    aliasmetric nameAny stringThe substitute name to be used in the metric browser instead of metric name.
    statType“ave”“AVERAGE”, “SUM”, “MIN”, “MAX”AWS configured values as returned by API
    aggregationType“AVERAGE”“AVERAGE”, “SUM”, “OBSERVATION”Aggregation qualifier
    timeRollUpType“AVERAGE”“AVERAGE”, “SUM”, “CURRENT”Time roll-up qualifier
    clusterRollUpType“INDIVIDUAL”“INDIVIDUAL”, “COLLECTIVE”Cluster roll-up qualifier
    multiplier1Any numberValue with which the metric needs to be multiplied.
    convertnullAny key value mapSet of key value pairs that indicates the value to which the metrics need to be transformed. eg: UP:0, DOWN:1
    deltafalsetrue, falseIf enabled, gives the delta values of metrics instead of actual values.

    For example,

    - name: "BackupToS3.Bytes"
      alias: "S3 Backup Bytes (Unit - byte; StatType - sum)"
      statType: "sum"
      aggregationType: "AVERAGE"
      timeRollUpType: "AVERAGE"
      clusterRollUpType: "INDIVIDUAL"
      delta: false
      multiplier: 1
    

    All these metric properties are optional, and the default value shown in the table is applied to the metric(if a property has not been specified) by default.

Config.yml

Please avoid using tab (\t) when editing yaml files. Please copy all the contents of the config.yml file and go to Yaml Validator . On reaching the website, paste the contents and press the “Go” button on the bottom left.
If you get a valid output, that means your formatting is correct and you may move on to the next step.

Metrics

Typical metric path:

Application Infrastructure Performance|<Tier>|Custom Metrics|AWS Kinesis Data Firehose|<Account Name>|<Region>|DeliveryStreamName|<stream_name>|
followed by the metrics defined in the link below:

Credentials Encryption

Please visit this page to get detailed instructions on password encryption. The steps in this document will guide you through the whole process.

Extensions Workbench

Workbench is an inbuilt feature provided with each extension in order to assist you to fine tune the extension setup before you actually deploy it on the controller. Please review the following document on How to use the Extensions WorkBench

Troubleshooting

Please follow the steps listed in this troubleshooting-document in order to troubleshoot your issue. These are a set of common issues that customers might have faced during the installation of the extension. If these don’t solve your issue, please follow the last step on the troubleshooting-document to contact the support team.

Support Tickets

If after going through the Troubleshooting Document you have not been able to get your extension working, please file a ticket and add the following information.

Please provide the following in order for us to assist you better.

  1. Stop the running machine agent.
  2. Delete all existing logs under <MachineAgent>/logs.
  3. Please enable debug logging by editing the file <MachineAgent>/conf/logging/log4j.xml. Change the level value of the following <logger> elements to debug.
    <logger name="com.singularity">
    <logger name="com.appdynamics">
    
  4. Start the machine agent and please let it run for 10 mins. Then zip and upload all the logs in the directory <MachineAgent>/logs/*.
  5. Attach the zipped <MachineAgent>/conf/* directory here.
  6. Attach the zipped <MachineAgent>/monitors/ExtensionFolderYouAreHavingIssuesWith directory here.

For any support related questions, you can also contact help@appdynamics.com.

Contributing

Always feel free to fork and contribute any changes directly here on GitHub.

Version

NameVersion
Extension Version1.0.0
Controller Compatibility4.4 or Later
Last Update21 August 2018