Passer au contenu principal

Create a Subscription

Once you have created a stream, create a subscription to send your metrics and event data to your data collector.

Supported Data Collectors:

Data CollectorEventsMetrics
DatadogSupportedSupported
Google Pub/SubSupportedSupported
Grafana WebhookSupportedSupported
Microsoft TeamsSupportedSupported
PagerDutySupportedNot Supported
ServiceNowSupportedSupported
Slack WebhookSupportedSupported
Splunk HECSupportedSupported
Generic WebhooksSupportedSupported

Data Formats​

Equinix Events and Metrics use the CloudEvents specification format or the OpenTelemetry specification format for all data. All of our event data schemas, metrics data schemas, and data types are published in the /equinix/equinix-cloudevents GitHub repository.

Examples:

---
specversion: '1.0'
source: https://api.equinix.com/fabric/v4/cloudevents
id: 6c573287-9914-4202-8b6d-2d15e7da04b8
type: equinix.fabric.metric
subject: /fabric/v4/ports/956a86fb-d03d-436c-8d5d-30d1f51f7688
time: '2024-07-01T20:12:21.306Z'
severitynumber: 9
severitytext: INFO
equinixproject: 123
dataschema: https://github.com/Fabric/.../ApiConfigEventData.json
datacontenttype: application/json
data:
  message: New metrics collected
  resource:
    href: https://api.equinix.com/fabric/v4/ports/956a86fb-d03d-436c-8d5d-30d1f51f7688
    uuid: 956a86fb-d03d-436c-8d5d-30d1f51f7688
    name: my-test-port
    description: port description
  metrics:
  - type: GAUGE
    name: equinix.fabric.port.bandwidth_rx.usage
    description: Port inbound bandwidth utilization
    unit: bit/s
    datapoints:
    - endDateTime: '2024-07-01T20:12:21.000Z'
      value: 440023
  - type: SUM
    name: equinix.fabric.port.packets_erred_tx.count
    description: Port error packets
    interval: PT5M
    unit: packet
    datapoints:
    - endDateTime: '2024-07-01T20:12:21.000Z'
      value: 10

Any variations of these formats for specific data collectors are included below.

Prerequisites​

  • 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.

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

  1. Sign 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

Datadog​

A Datadog subscription requires your Datadog API and Application Keys when creating your subscription.

For a setup guide to integrate with Datadog, see How to set up Datadog in the Equinix Community.

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

Datadog Data Examples​

---
date_happened: 1719864741 # in seconds
source_type_name: Equinix
aggregation_key: <aggregation_key>
title: 'Virtual port status changed to Up'
status: info # INFO->info, WARN -> warn, ERROR->error, CRITICAL->warn, FATAL->error, default: info
text: "{\"cloudevent\":{\"specversion\":\"1.0\",\"source\":\"https://api.equinix.com/fabric/v4/cloudevents\",\"id\":\"6c573287-9914-4202-8b6d-2d15e7da04b8\",\"type\":\"equinix.fabric.port.status.up\",\"subject\":\"/fabric/v4/ports/956a86fb-d03d-436c-8d5d-30d1f51f7688\",\"time\":\"2024-07-01T20:12:21.306Z\",\"severitynumber\":9,\"severitytext\":\"INFO\",\"equinixalert\":\"clear/<aggregation_key>\",\"equinixproject\":\"123\",\"data\":{\"message\":\"Virtual port status changed to Up\",\"resource\":{}}}}"

Google PubSub​

A Google Pub/Sub Subscription requires the following:

For a setup guide on Google Pub/Sub, see How to set up Google Pub/Sub in the Equinix Community.

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​

To create a Grafana subscription, create and configure Grafana for incoming webhooks. Provide your Grafana Webhook's URL and api key when creating your subscription.

For a setup guide for Grafana, see How to set up Grafana Webhook in the Equinix Community.

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​

To create a Microsoft Teams subscription, create and configure a webhook to post messages when a webhook request is received. Once your webhook is configured, provide your HTTP POST URL when creating your subscription.

For a setup guide for Microsoft Teams, see How to set up Microsoft Teams in the Equinix Community.

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​

For a PagerDuty subscription, create a service and an Events APIv2 integration to handle your events. Provide your PagerDuty URI and the Integration Key when creating your subscription.

For a setup guide for PagerDuty, see How to set up PagerDuty in the Equinix Community.

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

PagerDuty Data Example​

---
routing_key: <routing_key>
dedup_key: <dedup_key>
event_action: trigger # or resolve
payload:
  source: Equinix
  timestamp: '2024-07-01T20:12:21.306Z'
  severity: critical
  summary: Virtual port status changed to Down
  custom_details:
    equinixsource: https://api.equinix.com/fabric/v4/cloudevents
    specversion: '1.0'
    id: <uuid>
    type: equinix.fabric.port.status.down
    subject: /fabric/v4/ports/<port_uuid>
    time: '2024-07-01T20:12:21.306Z'
    severitynumber: 21
    severitytext: FATAL # or INFO
    equinixalert: raise/<dedup_key>
    equinixproject: 123

ServiceNow​

A ServiceNow subscription requires your ServiceNow username and password.

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.

ServiceNow Data Examples​

---
source: Equinix
time_of_event: '2024-07-01T20:12:21.306Z'
description: Virtual port status changed to Down
severity: 1 # 1 for clear and 0 for clear
resolution_state: New # or Closing
message_key: NCAB543WC4lrLpET8nLX4Vd8
resource: fabric.port
node: /fabric/v4/ports/956a86fb-d03d-436c-8d5d-30d1f51f7688
type: equinix.fabric.port.status.down
additional_info: '{"cloudevent":{"specversion":"1.0","source":"https://api.equinix.com/fabric/v4/cloudevents","id":"6c573287-9914-4202-8b6d-2d15e7da04b8","type":"equinix.fabric.port.status.down","subject":"/fabric/v4/ports/956a86fb-d03d-436c-8d5d-30d1f51f7681","time":"2024-07-01T20:12:21.306Z","severitynumber":13,"severitytext":"CRITICAL","equinixalert":"raise/NCAB543WC4lrLpET8nLX4Vd8","equinixproject":"123","data":{"message":"Virtual port named \'Test-port\' status changed to Down","resource":{}}}}'

Slack​

A Slack subscription requires your webhook's unique URL. See create and configure a Slack App for incoming webhooks.

For a setup guide to integrate with Slack, see How to set up Slack in the Equinix Community.

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

  • Subscription name
  • Subscription URI
  • Description (optional)

Splunk​

To create a Splunk subscription, create an event index to receive events, a metrics index to receive metrics or both, then create an HTTP Event Collector. Provide your HTTP Event Collector URI, your HTTP Event Collector token, and the names of your indices when creating your subscription.

For a setup guide to integrate with Splunk, see How to set up Splunk in the Equinix Community.

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

Splunk Data Examples​

---
sourcetype: _json
index: test-event-index
source: equinix # optional
event:
  equinixsource: https://api.equinix.com/fabric/v4/cloudevents
  specversion: '1.0'
  id: 6c573287-9914-4202-8b6d-2d15e7da04b8
  type: equinix.fabric.port.status.up
  subject: /fabric/v4/ports/956a86fb-d03d-436c-8d5d-30d1f51f7688
  time: '2024-07-01T20:12:21.306Z'
  severitynumber: 9
  severitytext: INFO
  equinixalert: clear/NCAB543WC4lrLpET8nLX4Vd8
  equinixproject: 123
  data:
    message: Virtual port status changed to Up
    resource:
      href: https://api.equinix.com/fabric/v4/ports/956a86fb-d03d-436c-8d5d-30d1f51f7688
      uuid: 956a86fb-d03d-436c-8d5d-30d1f51f7688
      name: my-test-port
      description: port description

Generic Webhook​

Equinix supports creating a subscription to any generic webhook service for events and metrics in either CloudEvent specification format or OpenTelemetry specification format.

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).

Cette page a-t-elle été utile ?