Salesforce and Sensu Integration

Input and output integration overview

The Salesforce Telegraf plugin collects crucial metrics regarding the API usage and limits in Salesforce organizations, enabling effective monitoring and management of API consumption.

This plugin writes metrics events to Sensu via its HTTP events API, enabling seamless integration with the Sensu monitoring platform.

Integration details

Salesforce

The Salesforce plugin allows users to gather metrics about API usage limits and the remaining usage within their Salesforce organization. By leveraging Salesforce’s REST API, specifically the limits endpoint, this plugin provides critical insights into how much of the API usage has been consumed and what remains available. This is particularly important for organizations that rely on Salesforce for their operations, as exceeding API limits can interrupt service and hinder business processes. The plugin processes data into a structured format containing maximum and remaining values for various API operations, making it easier for teams to monitor their usage and plan accordingly. The provided configuration allows users to customize their credentials, environment type (sandbox or production), and API version, ensuring flexibility in different deployment scenarios.

Sensu

This plugin writes metrics events to Sensu via its HTTP events API. Sensu is a monitoring system that enables users to collect, analyze, and manage metrics from various components in their infrastructure. The plugin facilitates the integration of Telegraf, a server agent for collecting and reporting metrics, with the Sensu monitoring platform. Users can configure settings such as backend and agent API URLs, API keys for authentication, and optional TLS settings. The plugin’s core functionality is centered around sending metric events, including check and entity specifications, to Sensu, allowing for comprehensive monitoring and alerting. The API reference provides extensive details about the events and metrics structure, ensuring users can efficiently leverage Sensu’s capabilities for observability and incident response.

Configuration

Salesforce

[[inputs.salesforce]]
  ## specify your credentials
  ##
  username = "your_username"
  password = "your_password"
  ##
  ## (optional) security token
  # security_token = "your_security_token"
  ##
  ## (optional) environment type (sandbox or production)
  ## default is: production
  ##
  # environment = "production"
  ##
  ## (optional) API version (default: "39.0")
  ##
  # version = "39.0"

Sensu

[[outputs.sensu]]
  ## BACKEND API URL is the Sensu Backend API root URL to send metrics to
  ## (protocol, host, and port only). The output plugin will automatically
  ## append the corresponding backend API path
  ## /api/core/v2/namespaces/:entity_namespace/events/:entity_name/:check_name).
  ##
  ## Backend Events API reference:
  ## https://docs.sensu.io/sensu-go/latest/api/events/
  ##
  ## AGENT API URL is the Sensu Agent API root URL to send metrics to
  ## (protocol, host, and port only). The output plugin will automatically
  ## append the correspeonding agent API path (/events).
  ##
  ## Agent API Events API reference:
  ## https://docs.sensu.io/sensu-go/latest/api/events/
  ##
  ## NOTE: if backend_api_url and agent_api_url and api_key are set, the output
  ## plugin will use backend_api_url. If backend_api_url and agent_api_url are
  ## not provided, the output plugin will default to use an agent_api_url of
  ## http://127.0.0.1:3031
  ##
  # backend_api_url = "http://127.0.0.1:8080"
  # agent_api_url = "http://127.0.0.1:3031"

  ## API KEY is the Sensu Backend API token
  ## Generate a new API token via:
  ##
  ## $ sensuctl cluster-role create telegraf --verb create --resource events,entities
  ## $ sensuctl cluster-role-binding create telegraf --cluster-role telegraf --group telegraf
  ## $ sensuctl user create telegraf --group telegraf --password REDACTED
  ## $ sensuctl api-key grant telegraf
  ##
  ## For more information on Sensu RBAC profiles & API tokens, please visit:
  ## - https://docs.sensu.io/sensu-go/latest/reference/rbac/
  ## - https://docs.sensu.io/sensu-go/latest/reference/apikeys/
  ##
  # api_key = "${SENSU_API_KEY}"

  ## Optional TLS Config
  # tls_ca = "/etc/telegraf/ca.pem"
  # tls_cert = "/etc/telegraf/cert.pem"
  # tls_key = "/etc/telegraf/key.pem"
  ## Use TLS but skip chain & host verification
  # insecure_skip_verify = false

  ## Timeout for HTTP message
  # timeout = "5s"

  ## HTTP Content-Encoding for write request body, can be set to "gzip" to
  ## compress body or "identity" to apply no encoding.
  # content_encoding = "identity"

  ## NOTE: Due to the way TOML is parsed, tables must be at the END of the
  ## plugin definition, otherwise additional config options are read as part of
  ## the table

  ## Sensu Event details
  ##
  ## Below are the event details to be sent to Sensu.  The main portions of the
  ## event are the check, entity, and metrics specifications. For more information
  ## on Sensu events and its components, please visit:
  ## - Events - https://docs.sensu.io/sensu-go/latest/reference/events
  ## - Checks -  https://docs.sensu.io/sensu-go/latest/reference/checks
  ## - Entities - https://docs.sensu.io/sensu-go/latest/reference/entities
  ## - Metrics - https://docs.sensu.io/sensu-go/latest/reference/events#metrics
  ##
  ## Check specification
  ## The check name is the name to give the Sensu check associated with the event
  ## created. This maps to check.metadata.name in the event.
  [outputs.sensu.check]
    name = "telegraf"

  ## Entity specification
  ## Configure the entity name and namespace, if necessary. This will be part of
  ## the entity.metadata in the event.
  ##
  ## NOTE: if the output plugin is configured to send events to a
  ## backend_api_url and entity_name is not set, the value returned by
  ## os.Hostname() will be used; if the output plugin is configured to send
  ## events to an agent_api_url, entity_name and entity_namespace are not used.
  # [outputs.sensu.entity]
  #   name = "server-01"
  #   namespace = "default"

  ## Metrics specification
  ## Configure the tags for the metrics that are sent as part of the Sensu event
  # [outputs.sensu.tags]
  #   source = "telegraf"

  ## Configure the handler(s) for processing the provided metrics
  # [outputs.sensu.metrics]
  #   handlers = ["influxdb","elasticsearch"]

Input and output integration examples

Salesforce

1. Monitoring API Limit Usage for Scaling Decisions: Use the Salesforce plugin to track API limit usage over time and make informed decisions about when to scale Salesforce resources. By visualizing API consumption patterns, organizations can predict peak usage times, allowing them to proactively adjust their infrastructure or request higher limits as needed. This optimization leads to better performance and less downtime during critical business operations.

2. Automated Alert System for API Limit Exceedance: Integrate this plugin with a notification system to alert teams when API usage approaches critical limits. This setup not only ensures teams are proactively notified to prevent disruptions, but also helps in maintaining operational continuity and customer satisfaction. The alerts can be configured to trigger automated scripts that either adjust load or inform stakeholders accordingly.

3. Comparative Analysis of Multiple Salesforces: Leverage the Salesforce Input Plugin to gather metrics from multiple Salesforce instances across different departments or business units. By centralizing this data, organizations can perform comparative analyses to identify departments that may be exceeding their API limits more frequently than others. This allows for targeted discussions and strategies to balance API usage across the organization, leading to better resource allocation and efficiency.

Sensu

1. Real-Time Infrastructure Monitoring: Utilize the Sensu plugin to send performance metrics from various servers and services directly to Sensu. This real-time data flow enables teams to visualize infrastructure health, track resource usage, and receive immediate alerts for any anomalies detected. By centralizing monitoring through Sensu, organizations can create a holistic view of their systems and respond swiftly to issues.

2. Automated Incident Response Workflows: Leverage the plugin to automatically trigger incident response workflows based on the metrics events sent to Sensu. For example, if CPU usage exceeds a defined threshold, the Sensu system can be configured to alert the operations team, which can then initiate automated remediation processes, reducing downtime and maintaining system reliability. This integration allows for proactive management of system resources.

3. Dynamic Scaling of Resources: Use the Sensu plugin to feed metrics into an auto-scaling system that adjusts resources based on demand. By tracking metrics like request load and resource utilization, organizations can automatically scale their infrastructure up or down, ensuring optimal performance and cost efficiency without manual intervention.

4. Centralized Logging and Monitoring: Combine the Sensu with logging tools to send logs and performance metrics to a centralized monitoring system. This comprehensive approach allows teams to correlate logs with metric events, providing deeper insights into system behavior and performance, which aids in troubleshooting and performance optimization over time.

Feedback

Thank you for being part of our community! If you have any general feedback or found any bugs on these pages, we welcome and encourage your input. Please submit your feedback in the InfluxDB community Slack.