Skip to content

Add MongoDB Atlas Metrics and Logs Documentation #1676

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

Calm-Rock
Copy link
Member

@Calm-Rock Calm-Rock commented Jul 15, 2025

This PR adds comprehensive documentation for MongoDB Atlas metrics and logs collection with SigNoz, following the updated issue requirements that now include both metrics and logs.

What's included:

Documentation Structure

  • Overview: Clarified approach - explains how to collect MongoDB Atlas telemetry using OpenTelemetry receiver
  • Prerequisites: Focused on MongoDB Atlas requirements and API permissions
  • Setup: Complete step-by-step guide starting with OpenTelemetry Collector installation
  • Dashboard: Instructions for importing the MongoDB Atlas dashboard
  • Logs Explorer: Documentation for logs collection and visualization
  • Metrics Reference: Complete list of available MongoDB Atlas metrics
  • Troubleshooting: Common issues and solutions for logs collection

Key Features

  • Metrics Collection: 25+ MongoDB Atlas metrics including database, performance, operations, and resource utilization
  • Logs Collection: Comprehensive logs including:
    • Audit logs (database audit trail)
    • Host logs (mongod, mongos server logs)
    • Access logs (authentication/authorization events)
    • Project events (configuration changes)
    • Organization events (admin actions)
  • ✅ Uses official OpenTelemetry Collector (not distros)
  • ✅ Supports both SigNoz Cloud and Self-hosted deployments
  • ✅ Complete YAML configuration examples for metrics and logs
  • ✅ Environment variables setup guide
  • ✅ Storage extension configuration to prevent duplicate data
  • ✅ Project and cluster filtering options
  • ✅ Image placeholders for both metrics and logs screenshots

Technical Details

  • File: data/docs/integrations/mongodb-atlas.mdx
  • ID: mongodb-atlas
  • Title: MongoDB Atlas Metrics and Logs
  • Sidebar: Will appear under integrations section

Setup Structure Changes

  • Step 1: Install OpenTelemetry Collector (moved from prerequisites)
  • Step 2: Create collector config file (includes both metrics and logs)
  • Step 3: Set environment variables (expanded for logs)
  • Step 4: Run collector with config

Configuration Highlights

  • Metrics: Database size, operations counters, CPU/memory usage, connections, network I/O
  • Logs: Audit logs, host logs, access logs with filtering and pagination options
  • Events: Project and organization events with configurable polling
  • Storage: File storage extension to prevent data duplication

Dashboard Reference

References the dashboard location: https://github.com/SigNoz/dashboards/blob/main/mongodb/mongodb-atlas-otlp-v1.json

Images Required

The documentation includes placeholders for the following screenshots:

Metrics Dashboards:

  • /img/docs/integrations/mongodb-atlas/cluster-overview.webp
  • /img/docs/integrations/mongodb-atlas/database-metrics.webp
  • /img/docs/integrations/mongodb-atlas/performance-metrics.webp
  • /img/docs/integrations/mongodb-atlas/operations-metrics.webp
  • /img/docs/integrations/mongodb-atlas/resource-utilization.webp

Logs Explorer:

  • /img/docs/integrations/mongodb-atlas/audit-logs.webp
  • /img/docs/integrations/mongodb-atlas/host-logs.webp
  • /img/docs/integrations/mongodb-atlas/access-logs.webp
  • /img/docs/integrations/mongodb-atlas/events-logs.webp

Prerequisites Documentation

  • MongoDB Atlas account with API access
  • API key permissions (Project Read Only, Organization Member roles)
  • Audit logging enabled in Atlas (for audit logs)

Troubleshooting Section

  • Common logs collection issues and solutions
  • Error message explanations
  • Configuration verification steps

Resolves #1615

Copy link

vercel bot commented Jul 15, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
signoz-web ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jul 15, 2025 8:09am

@Calm-Rock Calm-Rock changed the title Add MongoDB Atlas Integration Documentation Add MongoDB Atlas Metrics and Logs Documentation Jul 15, 2025
@Calm-Rock
Copy link
Member Author

✅ Documentation Updated Successfully!

The MongoDB Atlas documentation has been updated to address all the feedback and align with the updated issue requirements:

🔄 Key Changes Made:

📊 Expanded Coverage

  • Title: Updated to "MongoDB Atlas Metrics and Logs"
  • Scope: Now covers comprehensive metrics AND logs collection

📝 Improved Overview

  • Fixed: Removed misleading "out-of-the-box dashboard" language
  • Clarified: This explains how to collect MongoDB Atlas telemetry using OpenTelemetry receiver
  • Accurate: Mentions there is a dashboard available for use (not claiming it comes automatically)

⚙️ Restructured Setup Process

  • Step 1: OpenTelemetry Collector installation (moved from prerequisites as requested)
  • Step 2: Create collector config file (now includes both metrics and logs)
  • Step 3: Set environment variables (expanded for logs)
  • Step 4: Run collector with config

📋 Enhanced Prerequisites

  • Focused: Only MongoDB Atlas account and API requirements
  • Specific: API key permissions (Project Read Only, Organization Member)
  • Clear: Audit logging requirement for audit logs

🗂️ Complete Logs Documentation

Added comprehensive logs collection including:

  • 🔍 Audit Logs: Database audit trail (requires Atlas audit logging)
  • 📋 Host Logs: mongod and mongos server logs
  • 🔐 Access Logs: Authentication/authorization events with filtering
  • 📅 Project Events: Configuration changes and project activities
  • 🏢 Organization Events: Admin actions and org-level changes

📊 Technical Enhancements

  • Storage Extension: File storage to prevent duplicate data
  • Project Filtering: Include/exclude clusters configuration
  • Pagination: Configurable page sizes and limits for API calls
  • Polling Intervals: Customizable collection frequencies
  • Error Handling: Comprehensive troubleshooting section

🖼️ Image Placeholders

Added placeholders for 9 screenshots:

  • 5 Metrics Dashboards: Cluster overview, database metrics, performance, operations, resource utilization
  • 4 Logs Views: Audit logs, host logs, access logs, events in SigNoz Logs Explorer

🔧 Complete Configuration

  • Metrics: 25+ MongoDB Atlas metrics with detailed descriptions
  • Logs: Full YAML configuration with all log types
  • Storage: File storage extension setup
  • Exporters: Both SigNoz Cloud and self-hosted options

The documentation now provides complete coverage of MongoDB Atlas observability capabilities and follows the exact structure and requirements outlined in the updated issue!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[DOCS] MongoDB Atlas Metrics and Logs
1 participant