AppDynamics Monitoring Extension for use with Redis

Use Case

Redis is an in memory key-value data store. The Redis monitoring extension gathers Redis server statistics and display them in AppDynamics Metric Browser.

This extension works only with the standalone machine agent.

Installation

1. Download and unzip the RedisMonitor zip file into <MACHINE_AGENT_HOME>/monitors/ directory.
2. Configure the extension by referring to the below section.
3. Restart the machine agent.
4. In the AppDynamics Metric Browser, look for: Application Infrastructure Performance | <Tier> | Individual Nodes | <Node> | Custom Metrics | Redis

Configuration

Note : Please make sure to not use tab (\t) while editing yaml files. You may want to validate the yaml file using a yaml validator

1. Configure the Redis instances by editing the config.yml file in <MACHINE_AGENT_HOME>/monitors/RedisMonitor/. Specify the host, port of the Redis instance, password if authentication enabled and keyspaces. You can also add excludePatterns (regex) to exclude metrics from showing up in the AppDynamics controller.

   For eg.

       # List of Redis servers
       servers:
         - host: "localhost"
           port: 6379
           password: ""
           displayName: "localhost"
   
           includePatterns: [
              ]
           excludePatterns: [
                             .*tcp_port$,
                             .*master_port$,
                             .*Persistence|.*
                            ]
   
       #prefix used to show up metrics in AppDynamics
       metricPrefix:  "Custom Metrics|Redis|"
       # This will create it in specific Tier. Replace 
       # metricPrefix: "Server|Component:|Custom Metrics|Redis|"
   
   

Metrics

This extension uses INFO command to fetch metrics from Redis server. Some of the metrics are listed below.

• Server: uptime_in_seconds, uptime_in_days
• clients: blocked_clients, connected_clients
• memory: mem_fragmentation_ratio, used_memory, used_memory_peak, used_memory_rss
• replication: role (MASTER:1, SLAVE:0), master_link_status(UP:1, DOWN:0), connected_slaves, master_last_io_seconds_ago, master_link_down_since_seconds, master_sync_in_progress
• CPU
• Persistence
• Stats
• Keyspace: keys, expires
• commandstats: cmdstat_set, cmdstat_info, cmdstat_subscribe
• keyspace_hit_ratio = keyspace_hits/(keyspace_hits + keyspace_misses)

In addition to the above metrics, we also add a metric called "Metrics Collection Successful" with a value 0 when an error occurs and 1 when the metrics collection is successful.

Note : By default, a Machine agent or a AppServer agent can send a fixed number of metrics to the controller. To change this limit, please follow the instructions mentioned here. For eg.

    java -Dappdynamics.agent.maxMetrics=2500 -jar machineagent.jar

Custom Dashboard

Contributing

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

Support

For any questions or feature request, please contact AppDynamics Support.

1.0.0 - Release version

1.0.1 - Code Optimization. 

1.0.2 - Support for role metrics

1.0.3 - Revamped and Added more metrics. 

1.0.4 - JDK 1.6 compatible

1.0.5 - Added commandstats and keyspace_hit_ratio

1.0.6 - Added code fixes

1.0.7 - Fix for includePatterns