Skip to main content

MongoDB Plugin

The MongoDB plugin is a runtime-owned Mongo client with pool, timeout, metrics, and health-check management.

Runtime Facts​

ItemValue
Go modulegithub.com/go-lynx/lynx-mongodb
Config prefixlynx.mongodb
Runtime plugin namemongodb.client
Public APIsGetMongoDB(), GetMongoDBPlugin(), GetMongoDBDatabase(), GetMongoDBCollection(), GetMetricsGatherer()

What The Implementation Actually Does​

The plugin initializes one managed MongoDB client and can enable:

  • pool sizing and timeout control
  • TLS configuration
  • read concern and write concern settings
  • Prometheus command and pool monitoring
  • periodic health checks

This means the plugin is responsible for connectivity and operational behavior. Your repository layer remains responsible for collection structure and query design.

Configuration​

lynx:
  mongodb:
    uri: "mongodb://localhost:27017"
    database: "app"
    max_pool_size: 100
    min_pool_size: 5
    connect_timeout: 30s
    server_selection_timeout: 30s
    enable_metrics: true
    enable_health_check: true

What The Official Template Uses​

The official template does not wire MongoDB by default. It currently starts from MySQL plus Redis in bootstrap.local.yaml.

That is intentional, not a documentation gap:

  • the template chooses one concrete SQL path first
  • MongoDB remains an optional datastore you add when the service actually needs document-style storage
  • this page therefore describes a supported plugin, not a default scaffold dependency

How To Consume It​

import mongodb "github.com/go-lynx/lynx-mongodb"

client := mongodb.GetMongoDB()
db := mongodb.GetMongoDBDatabase()
orders := mongodb.GetMongoDBCollection("orders")
gatherer := mongodb.GetMetricsGatherer()

GetMetricsGatherer() matters if you want to merge plugin metrics into your application's /metrics endpoint.

Practical Notes​

  • The plugin tests connectivity during startup.
  • Background metrics and health-check goroutines are started only when enabled.
  • If you need higher-level repository abstractions, build them above this plugin rather than inside it.