Captures statistics for Amazon Kinesis Data Streams from Amazon CloudWatch and displays them in the AppDynamics Metric Browser.
mvn clean installfrom
AWSKinesisDataStreamsMonitorand provide the required configuration (see Configuration section).
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
Else, configure the "COMPONENT_ID" under which the metrics need to be reported. This can be done by changing the value of
metricPrefix: "Custom Metrics|AWS Kinesis Data Streams|"
metricPrefix: "Server|Component:<COMPONENT_ID>|Custom Metrics|AWS Kinesis Data Streams|".
metricPrefix: "Server|Component:100|Custom Metrics|AWS Kinesis Data Streams|"
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"]
trueand provide the encryption key in
encryptionKey. For example,
#Encryption key for Encrypted password. credentialsDecryptionConfig: enableDecryption: "true" encryptionKey: "XXXXXXXX"
To report metrics only from specific dimension values, configure the
dimesion section. Dimension for Kinesis Data Streams is
StreamName. For example to report metrics only from
StreamName dimension with value
dimensions as below -
dimensions: - name: "StreamName" displayName: "StreamName" values: ["Sample"]
.* is used, all dimension values are monitored and if empty, none are monitored.
If Enhanced Shard-level metrics is enabled, then please uncomment the dimension ShardId from
dimensions section in
config.yml, so that the section looks like below -
- name: "StreamName" displayName: "Stream Name" values: [".*"] # The dimension ShardId can only be used when retrieving Enhanced Shard-level Metrics. # To get this level of data, you must specifically enable it for the stream using the EnableEnhancedMonitoring operation. # Please refer https://docs.aws.amazon.com/kinesis/latest/APIReference/API_EnableEnhancedMonitoring.html for enabling. # AWS will charge for enhanced metrics emitted from Kinesis. - name: "ShardId" displayName: "Shard Id" values: [".*"]
config.ymlto report shard-level metrics.
Configure the metrics section.
For configuring the metrics, the following properties can be used:
|Property||Default value||Possible values||Description|
|alias||metric name||Any string||The 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|
|multiplier||1||Any number||Value with which the metric needs to be multiplied.|
|convert||null||Any key value map||Set of key value pairs that indicates the value to which the metrics need to be transformed. eg: UP:0, DOWN:1|
|delta||false||true, false||If enabled, gives the delta values of metrics instead of actual values.|
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.
- name: "Bytes" alias: "Bytes per minute (Unit - byte; StatType - sum)" statType: "sum" aggregationType: "AVERAGE" timeRollUpType: "AVERAGE" clusterRollUpType: "INDIVIDUAL" delta: false multiplier: 1
Please avoid using tab () 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.
Typical metric path:
Application Infrastructure Performance|<Tier>|Custom Metrics|AWS Kinesis Data Streams|<Account Name>|<Region>|StreamName|<stream_name>|followed by the metrics defined in the link below:
Please visit this page to get detailed instructions on password encryption. The steps in this document will guide you through the whole process.
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
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.
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.
<MachineAgent>/conf/logging/log4j.xml. Change the level value of the following
<logger>elements to debug.
<logger name="com.singularity"> <logger name="com.appdynamics">
For any support related questions, you can also contact.
Always feel free to fork and contribute any changes directly here on GitHub.
|Controller Compatibility||4.4 or Later|
|Last Update||21 August 2018|