Skip to main content

Managing Subscriptions

Use the Subscription Management APIs to manage the delivery of telemetry data to your data collector.

Prerequisites​

  • Before calling the Subscription Management APIs, refer to Data Collector Setup to set up a sink type of your choice.

  • To create subscriptions, you must have the Fabric Stream Subscription Manager (STREAM_SUBSCRIPTION PERMISSION CREATE AND READ) role. Contact your Company Administrator or IAM Administrator to manage access and roles.

  • If you're using the API, submit your user credentials, Client ID, and Client Secret for OAuth2 authentication. Refer to API Authentication for more information on how to authenticate your requests to the Equinix API.

Creating a Subscription​

The portal supports creating and managing subscriptions to Splunk, Datadog, Microsoft Teams, and PagerDuty.

  1. Log in to the Customer Portal > Fabric Dashboard.

  2. From the Observability menu, select Data Streams.

    Observability Drop-down Menu Screenshot

  3. From the Actions drop-down menu, select Add Subscriptions.

    Actions Drop-down Menu Screenshot

  4. Select the data collector for your Subscription from the drop-down menu. Refer to the examples below for the supported data collectors.

Datadog​

On the Add Subscription page, enter your Datadog information, including:

  • a Subscription Name
  • your Datadog Host URL
  • your Datadog API key
  • your Datadog Application key
  • and provide a description (optional)

Adding a Datadog Subscription Dialog Screenshot

Google PubSub​

On the Add Subscription page, enter your Google Cloud PubSub information, including:

  • A Subscription Name
  • The Google Cloud PubSub Access Token
  • The Google Cloud PubSub Subscription URI
  • And provide a description (optional)

Grafana Webhook​

On the Add Subscription page, enter your Grafana information, including:

  • A Subscription name.
  • The Grafana Metrics URI.
  • The Grafana Events URI.
  • Your Grafana API Key.
  • An optional description.

Microsoft Teams​

On the Add Subscription page, enter your Microsoft Teams information, including:

  • a Subscription Name
  • your Microsoft Workflow Webhook URI
  • and provide a description (optional)

Adding a Microsoft Teams Subscription Dialog Screenshot

PagerDuty​

On the Add Subscription page, enter your PagerDuty information, including:

  • a Subscription Name
  • your PagerDuty Host Url
  • your PagerDuty Integration Key
  • and provide a description (optional)

Adding a Pagerduty Subscription Dialog Screenshot

ServiceNow​

On the Add Subscription page, enter your ServiceNow information, including:

  • A Subscription name.
  • The ServiceNow Host URL.
  • Your ServiceNow username.
  • Your ServiceNow password.
  • An optional description.

Slack​

On the Add Subscription page, enter your Slack information, including:

  • Subscription name
  • Subscription URI
  • Description (optional)

Splunk​

On the Add Subscription page, enter your Splunk information, including:

  • a Subscription Name
  • your Splunk HTTP Event Collector URI
  • your Splunk Access Token
  • your Splunk Event Index (required)
  • your Splunk Metrics Index, if you plan to ingest metrics into Splunk
  • and provide a description (optional)

Adding a Splunk Subscription Dialog Screenshot

Generic Webhook​

Create a subscription to any generic webhook service for events and metrics. Specify the sink type as a webhook. You must include either an Event URI or a Metric URI. To stream both events and metrics, you must provide both an Event URI and a Metric URI. If you provide only one of these fields, then only the corresponding data type (events or metrics) is sent to the destination platform.

On the Add Subscription page, enter your Webhook information, including:

  • A Subscription Name
  • Select either CloudEvent format or Open Telemetry format for your streaming data.
  • The Event URI
  • The Metric URI
  • Select an Authentication Type from No Auth, Username/Password, Access Token, or API Key options. Enter the relevant information into the provided fields.
  • And provide a description (optional).

Viewing a Subscription​

  1. From the Observability menu, click Data Streams.

  2. Select a Stream from the Stream Inventory.

  3. On the Stream Details page, click Subscriptions.

Deleting a Subscription​

  1. From the Observability menu, click Data Streams.

  2. Select a Stream from the Stream Inventory.

  3. On the Stream Details page, click Subscriptions.

  4. In the Subscription Details, click the options menu ..., and Delete Subscription.

Was this page helpful?