miro-observability

name	miro-observability
description	Set up observability for Miro REST API v2 integrations with Prometheus metrics, OpenTelemetry traces, structured logging, and Grafana dashboards. Trigger with phrases like "miro monitoring", "miro metrics", "miro observability", "monitor miro", "miro alerts", "miro tracing".
allowed-tools	Read, Write, Edit
version	1.7.0
license	MIT
author	Jeremy Longshore <[e-mail]>
tags	["saas","miro","observability","monitoring"]
compatibility	Designed for Claude Code

Miro Observability

Overview

Comprehensive monitoring for Miro REST API v2 integrations: Prometheus metrics for request rates and latency, OpenTelemetry traces for request flow, structured logging, and alerting for rate limit and error conditions.

Prerequisites

Before applying this guide, confirm you have a Miro app or workspace appropriate to the task, a dedicated non-production board where changes can be tested safely, and only the OAuth scopes or administrative access the procedure requires.

Key Metrics

Metric	Type	Labels	Purpose
miro_requests_total	Counter	method, endpoint, status	Request volume
miro_request_duration_seconds	Histogram	method, endpoint	Latency distribution
miro_errors_total	Counter	error_type, endpoint	Error tracking
miro_rate_limit_remaining	Gauge	—	Credit headroom
miro_rate_limit_credits_used	Gauge	—	Credit consumption
miro_webhook_events_total	Counter	event_type, item_type	Webhook volume
miro_token_refresh_total	Counter	status	OAuth health

Prometheus Metrics

import { Registry, Counter, Histogram, Gauge } from 'prom-client';

const registry = new Registry();
registry.setDefaultLabels({ app: 'miro-integration' });

const requestCounter = new ({
  : ,
  : ,
  : [, , ]  ,
  : [registry],
});

 requestDuration =  ({
  : ,
  : ,
  : [, ]  ,
  : [, , , , , , , ],
  : [registry],
});

 errorCounter =  ({
  : ,
  : ,
  : [, ]  ,
  : [registry],
});

 rateLimitRemaining =  ({
  : ,
  : ,
  : [registry],
});

 rateLimitUsed =  ({
  : ,
  : ,
  : [registry],
});

 webhookCounter =  ({
  : ,
  : ,
  : [, ]  ,
  : [registry],
});