Mail, Queue & CLI

These instrumentations ship with the agent. Each one activates automatically when its package is installed in your application, and can be configured or disabled with a top-level option in config/monocle.ts.

Mail

If @adonisjs/mail is installed, the agent automatically instruments all emails sent through the mail service. Every email appears as a span in your traces with subject, recipients, and transport info. You can monitor email activity in the dedicated Emails dashboard.

To disable:

export default defineConfig({
  // ...
  mail: false,
})

Queue

If @adonisjs/queue (boringqueue) is installed, the agent instruments job dispatch and execution. Jobs appear in the Jobs dashboard with execution count, error rate, and latency metrics.

export default defineConfig({
  // ...
  queue: {
    // How consumer spans relate to producer spans
    // 'link': consumer span links to producer (default)
    // 'parent': consumer span is a child of the producer span
    executionSpanLinkMode: 'link',
  },
})

For BullMQ, install the separate BullMQ instrumentation. To reduce the volume of noisy jobs, see Job Sampling.

Ace commands

Ace CLI command execution is traced by default. Scaffolding commands (make:*, generate:*) and long-running queue workers are excluded automatically.

Command arguments and flags are captured as span attributes (cli.args.*, cli.flags.*).

export default defineConfig({
  // ...
  cli: {
    // Glob patterns to include (all commands by default)
    include: ['migration:*', 'db:*'],
    // Glob patterns to exclude (defaults below)
    exclude: ['make:*', 'generate:*', 'queue:work', 'queue:listen'],
  },
})

To disable entirely:

export default defineConfig({
  // ...
  cli: false,
})

import '../otel.js' // Must be the first import

import { Kernel } from '@adonisjs/core/ace'
// ...

Optional integrations

Other libraries are supported through separate packages that you install and register in integrations: