AWS RDS

Learn about other supported AWS services on our AWS docs.

Sensor (Data Collection)

Tracked Configuration

RDS Instance Details Description
ARN The unqualified Amazon Resource Name (ARN) assigned to the instance.
Endpoint The endpoint of the instance.
Port The port of the instance.
Master User The master user of the instance.
Availability Zone The location of the instance.
Engine The instance engine.
Cluster The instance of cluster.

Metrics

RDS Instance metrics Description
CPUUtilization The percentage of CPU utilization.
CPUCreditUsage The number of CPU credits spent by the instance for CPU utilization.
CPUCreditBalance The number of earned CPU credits that an instance has accrued since it was launched or started.
BurstBalance The percent of General Purpose SSD (gp2) burst-bucket I/O credits available.
DatabaseConnections The number of database connections in use.
DiskQueueDepth The number of outstanding IOs (read/write requests) waiting to access the disk.
FreeableMemory The amount of available random access memory.
FreeStorageSpace The amount of available storage space.
ReplicaLag The amount of time a Read Replica DB instance lags behind the source DB instance.
SwapUsage The amount of swap space used on the DB instance.
ReadIOPS The average number of disk read I/O operations per second.
WriteIOPS The average number of disk write I/O operations per second.
ReadLatency The average amount of time taken per disk I/O operation.
WriteLatency The average amount of time taken per disk I/O operation.
ReadThroughput The average number of bytes read from disk per second.
WriteThroughput The average number of bytes written to disk per second.
NetworkReceiveThroughput The incoming network traffic on the DB instance, including both customer database traffic and Amazon RDS traffic used for monitoring and replication.
NetworkTransmitThroughput The outgoing network traffic on the DB instance, including both customer database traffic and Amazon RDS traffic used for monitoring and replication.
VolumeBytesUsed (Aurora) The amount of storage used by your Aurora DB instance.

Required Permissions

  • cloudwatch:GetMetricStatistics
  • cloudwatch:GetMetricData
  • rds:DescribeDBInstances
  • rds:DescribeEvents
  • rds:ListTagsForResource

Configuration

Metrics for RDS are pulled every 60 seconds, this can be changed via agent configuration in <agent_install_dir>/etc/instana/configuration.yml:

com.instana.plugin.aws.rds:
  cloudwatch_period: 300

To disable monitoring of RDS instances use the following configuration:

com.instana.plugin.aws.rds:
  enabled: false

Multiple tags can be defined, separated by a comma. Tags should be provided as a key-value pair separated by :. In order to make configuration easier, it is possible to define which tags you want to include in discovery or exclude from discovery. In case of defining tag in both lists (include and exclude), exclude list has higher priority. If there is no need for services filtering, the configuration should not be defined. It’s not mandatory to define all values in order to enable filtering.

Users are able to specify how often sensors will poll the AWS tagged resources using the tagged-servies-poll-rate configuration property (default 300 seconds).

To define how often sensors will poll the tagged resources use following configuration:

com.instana.plugin.aws:
  tagged-servies-poll-rate: 60 #default 300

To include services by tags into discovery use following configuration:

com.instana.plugin.aws.rds:
    include_tags: # Comma separated list of tags in key:value format (e.g. env:prod,env:staging)

To exclude services by tags from discovery use following configuration:

com.instana.plugin.aws.rds:
    exclude_tags: # Comma separated list of tags in key:value format (e.g. env:dev,env:test)

Instana Agent Tags

Please note that tags are currently only available in conjunction with the dedicated AWS Instana agent, described here AWS Agent Installation docs. More detail on using tags is described here.