influxdata/telegraf

Migrate from couchbase/go-couchbase to couchbase/gocb

Open

#9,813 opened on Sep 23, 2021

View on GitHub
 (1 comment) (0 reactions) (0 assignees)Go (9,892 stars) (4,161 forks)batch import
area/couchbasehelp wantedsize/l

Description

Couchbase provides two go client modules. couchbase/gocb is the current official module and couchbase/go-couchbase is an older unofficial module.

The telegraf couchbase input uses couchbase/go-couchbase. We have recently had to work around missing functionality (#9032) and insecure code (#9485) in it.

Telegraf should switch to gocb because it is the official supported module.

There is an old closed issue to switch to gocb (#2418). At the time of that issue the gocb module was new and didn't have functionality telegraf needed. We should revisit this now that time has past and gocb has matured.

Contributor guide

Tech stack
go
Domain
backend
Issue type
refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
4
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
3-5 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Go programmingCouchbase basicsTelegraf plugin structure
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
30
Research direction
Start by reviewing the closed issue #2418 for historical context. Then examine the current couchbase input plugin in the telegraf repository (plugins/inputs/couchbase/). Understand the gocb API by reading its documentation. The migration involves replacing couchbase/go couchbase calls with gocb equivalents, ensuring all metrics are collected correctly. Check if there are any breaking changes or missing features in gocb compared to the old client.