Agent Properties of the Redis agent (4369538)

Agent Properties of the Redis agent

Below is a full list, with explanations, of the configurable properties of the Foglight for Redis© agent current as of the 6.1.1.10 cartridge release.

To modify the agent configuration after creation, use the Agent Status dashboard.

 

Environment

An environment is a container internal to Foglight used to encapsulate and differentiate different logical groupings of Redis components. This facilitates, for example, differentiation in Foglight of Redis databases with the same name in production and development environments.

• Environment Name – The Environment property is an arbitrary label. It is crucial that a unique value be set for each agent to prevent the agents’ data from being merged into a single environment. If a monitoring agent is deleted and replaced with another agent, the same value should be used for the environment so that data collected from the new agent is merged into the existing data. Alternatively, use a different label to prevent merging with existing data

REST Connection

Monitoring data for Redis Enterprise clusters is gathered via the REST API.

• REST Address – The REST API endpoint. This address must, in most cases, include a port number, e.g., https://some.address.com:9443. The REST API endpoint is normally the cluster’s FQDN followed by the port 9443. The address used must match the name SSL certificate (see also Enable Certificate Authentication ). Typically, take the public endpoint of one of the cluster’s databases and replace the port number with 9443. If this endpoint is not a published domain name record, add an appropriate entry to the Foglight Agent Manager’s hosts file to facilitate lookup.
• REST API Key – The REST user’s username. See Redis Agent User Permissions
• REST API Secret – The REST user’s password.
• Disable SSL certificate authentication? – When disabled, the agent does not verify that SSL chains terminate in a trusted authority. Check this box if the Redis Enterprise nodes are using self-signed certificates that have not been imported into the FglAM’s truststore. It is recommended to only disable SSL certificate authentication for testing or in trial environments.

Collection Periods

Collection Periods – Intervals in seconds between agent data collections. Different collection types can be scheduled at different intervals. Defaults are set based on the type of data being collected. A given collection can be disabled by setting its interval to zero. The following are the configurable collection periods: "Alerts", "Log", "Cluster", "Cluster Stats", "Node", "Node Stats", "DB", and "DB Stats".

Options

Host Aliases – A list that maps a host name or IP address to an alias. Enter the address the host should be known as within Foglight into the “Connection Address” field, and enter any other address under which the host may be encountered within the monitoring environment into the “Alternate Address” field. An alias can be used to standardize internal representations (e.g., in a cloud environment) to their external address. This enables, for example, the Redis agent cartridge dashboards to link directly to the Foglight Hosts dashboard by ensuring host data is submitted uniformly across the monitoring environment.

Review the most recent Foglight for Redis user guide for the more current information.