dcp

Go Dcp

This repository contains go implementation of a Couchbase Database Change Protocol (DCP) client. You can find more information by looking at our docs.

Contents

• Why?
• Usage
• Configuration
• Examples

Why?

• Our main goal is to build a dcp client for faster and stateful systems. We're already using this repository in below implementations:
  • Elastic Connector
  • Kafka Connector
  • Couchbase Connector
  • SQL Connector
  • MongoDB Connector
  • Cassandra Connector
  • Redis Connector

Example

package main

import (
  "github.com/Trendyol/go-dcp"
  "github.com/Trendyol/go-dcp/logger"
  "github.com/Trendyol/go-dcp/models"
)

func listener(ctx *models.ListenerContext) {
  switch event := ctx.Event.(type) {
  case models.DcpMutation:
    logger.Log.Info(
      "mutated(vb=%v,eventTime=%v) | id: %v, value: %v | isCreated: %v",
      event.VbID, event.EventTime, string(event.Key), string(event.Value), event.IsCreated(),
    )
  case models.DcpDeletion:
    logger.Log.Info(
      "deleted(vb=%v,eventTime=%v) | id: %v",
      event.VbID, event.EventTime, string(event.Key),
    )
  case models.DcpExpiration:
    logger.Log.Info(
      "expired(vb=%v,eventTime=%v) | id: %v",
      event.VbID, event.EventTime, string(event.Key),
    )
  }

  ctx.Ack()
}

func main() {
  connector, err := dcp.NewDcp("config.yml", listener)
  if err != nil {
    panic(err)
  }

  defer connector.Close()

  connector.Start()
}

Usage

$ go get github.com/Trendyol/go-dcp

Configuration

Environment Variables

These environment variables will overwrite the corresponding configs.

Monitoring

The client offers an API that handles different endpoints and expose several metrics.

API

The Client collects relevant metrics and makes them available at /metrics endpoint. In case you haven't configured a metric.path, the metrics will be exposed at the /metrics.

Exposed metrics

Compatibility

Breaking Changes

Examples

• example with couchbase membership
• couchbase membership config - thanks to @onursak
• kubernetesStatefulSet membership config
• kubernetesHa membership config
• static membership config
• dynamic membership config
• lilCouchbase membership config

Grafana Metric Dashboard

Grafana & Prometheus Example

Distributed Tracing

otel-go-dcp

Before Contribution

# Make sure to use .githooks as hooks path of your git
git config core.hooksPath .githooks