cx-observability-setup logo

cx-observability-setup

cx observability setup

coralogix/cx-cli360installs104starsCLI & Terminal

SKILL.md

Full skill instructions

Observability Setup Skill

Use this skill when setting up or configuring the observability stack - saved views, webhook integrations, notification channels, and external integrations. This is the "day 1 setup" skill for onboarding a new service or reconfiguring notification pipelines.


CLI Commands

Views

CommandPurpose
cx views listList all saved views
cx views get <id>Get a view definition
cx views create --from-fileCreate a saved view
cx views update <id> --from-fileUpdate a saved view
cx views delete <id>Delete a saved view
cx views folders listList view folders
cx views folders get <id>Get a folder
cx views folders create --from-fileCreate a folder
cx views folders update <id> --from-fileUpdate a folder
cx views folders delete <id>Delete a folder

Webhooks

CommandPurpose
cx webhooks listList all outgoing webhooks
cx webhooks get <id>Get webhook details
cx webhooks create --from-fileCreate a webhook
cx webhooks update <id> --from-fileUpdate a webhook
cx webhooks delete <id>Delete a webhook
cx webhooks test <id>Test a webhook
cx webhooks typesList available webhook types
cx webhooks actions listList automation actions
cx webhooks actions get <id>Get action details
cx webhooks actions create --from-fileCreate an action
cx webhooks actions update --from-fileUpdate an action
cx webhooks actions delete <id>Delete an action
cx webhooks actions batch --from-fileBatch execute actions
cx webhooks actions reorder --from-fileReorder actions

Notifications

CommandPurpose
cx notifications connectors listList notification connectors
cx notifications connectors get <id>Get connector details
cx notifications connectors create --from-fileCreate a connector
cx notifications connectors update --from-fileUpdate a connector
cx notifications connectors delete <id>Delete a connector
cx notifications connectors typesList connector types
cx notifications connectors entity-typesList entity types
cx notifications connectors entity-subtypes --type <type>List entity subtypes
cx notifications routers listList notification routers
cx notifications routers get <id>Get router details
cx notifications routers create --from-fileCreate a router
cx notifications routers update --from-fileUpdate a router
cx notifications routers delete <id>Delete a router
cx notifications routers validate-matcher --from-fileTest entity label matcher
cx notifications presets listList notification presets
cx notifications presets get <id>Get preset details
cx notifications presets create --from-fileCreate a custom preset
cx notifications presets update --from-fileUpdate a custom preset
cx notifications presets delete <id>Delete a custom preset
cx notifications presets set-default <id>Set default preset
cx notifications test connector --from-fileTest connector config
cx notifications test destination --from-fileTest destination
cx notifications test preset --from-fileTest preset config
cx notifications test routing-condition --from-fileTest routing condition
cx notifications test template-render --from-fileTest template rendering

Integrations

CommandPurpose
cx integrations listList all integrations
cx integrations get <id>Get integration details
cx integrations create --from-fileCreate an integration
cx integrations update <id> --from-fileUpdate an integration
cx integrations delete <id>Delete an integration
cx integrations test --from-fileTest integration config
cx integrations templateGet integration template
cx integrations definition <id>Get integration definition
cx integrations deployed <id>Get deployed integration
cx integrations extensions listList available extensions
cx integrations extensions get <id>Get extension details
cx integrations extensions deployedList deployed extensions
cx integrations extensions deploy --from-fileDeploy an extension
cx integrations extensions update --from-fileUpdate deployed extension
cx integrations extensions undeploy --from-fileUndeploy an extension
cx integrations contextual-data listList contextual data integrations
cx integrations contextual-data get <id>Get contextual data details
cx integrations contextual-data create --from-fileCreate contextual data integration
cx integrations contextual-data update <id> --from-fileUpdate contextual data integration
cx integrations contextual-data delete <id>Delete contextual data integration
cx integrations contextual-data definition <id>Get contextual data definition
cx integrations contextual-data test <id>Test contextual data integration

All commands support -o json for structured output and -p <profile> for profile selection.


New Service Setup Workflow

When onboarding a new service, follow this checklist:

1. Create Saved Views

Set up views for the service's key log queries:

cx views folders create --from-file folder.json
cx views create --from-file view.json

2. Set Up Notification Connectors

Configure channels (Slack, PagerDuty, email):

cx notifications connectors types -o json
cx notifications connectors create --from-file slack-connector.json

3. Configure Notification Routing

Route alerts to the right channels:

cx notifications routers create --from-file router.json

4. Set Up Webhooks

Configure outgoing webhooks for external integrations:

cx webhooks types -o json
cx webhooks create --from-file webhook.json
cx webhooks test <webhook-id>

5. Install Integrations

Deploy relevant integrations and extensions:

cx integrations list -o json
cx integrations create --from-file integration.json
cx integrations extensions deploy --from-file extension.json

6. Create Dashboard

Use the cx-dashboards skill for the full dashboard creation workflow.

7. Create SLOs

Use the cx-slos skill for SLO creation and monitoring.


Notification Setup Workflow

Detailed notification channel configuration:

1. List Available Connector Types

cx notifications connectors types -o json

2. Create a Connector

cx notifications connectors create --from-file connector.json

3. Create a Router

cx notifications routers create --from-file router.json

4. Assign or Create a Preset

cx notifications presets list -o json
cx notifications presets create --from-file preset.json
cx notifications presets set-default <preset-id>

5. Test End-to-End

cx notifications test connector --from-file test-connector.json
cx notifications test destination --from-file test-destination.json
cx notifications test routing-condition --from-file test-condition.json

Webhook Setup

1. List Webhook Types

cx webhooks types -o json

2. Create Webhook

Template from an existing webhook if possible:

cx webhooks get <existing-id> -o json > webhook-template.json
cx webhooks create --from-file webhook.json

3. Test Webhook

cx webhooks test <webhook-id>

4. Create Automation Actions (Optional)

cx webhooks actions create --from-file action.json
cx webhooks actions reorder --from-file order.json

Key Principles

  • Always test after setup - use cx notifications test, cx webhooks test, cx integrations test
  • Use --from-file for complex JSON payloads - pipe from stdin or use a file
  • Template from existing - cx <command> get <id> -o json > template.json before creating
  • Check connector types first - cx notifications connectors types and cx webhooks types before creating

Related Skills

  • cx-dashboards - dashboard creation and replace workflow
  • cx-slos - SLO creation and error-budget monitoring
  • cx-cases - triage the cases raised when alerts fire
  • cx-alerts - alert definitions that trigger notifications
  • cx-telemetry-querying - verify data flows after setup