Giter Site home page Giter Site logo

couchbaselabs / observability Goto Github PK

View Code? Open in Web Editor NEW
8.0 77.0 7.0 65.51 MB

Simple observability pipeline for Couchbase server using standard interfaces and components

License: Apache License 2.0

Dockerfile 0.07% Shell 0.55% HTML 98.85% Makefile 0.05% Jinja 0.01% Go 0.15% JavaScript 0.02% Lua 0.01% CSS 0.30%

observability's Introduction

Couchbase Monitoring and Observability Stack (CMOS)

CMOS is a simple, out-of-the-box solution based on industry standard tooling to observe the state of your Couchbase cluster.

  • An additional requirement is to ensure we can integrate into existing observability pipelines people may already have as easily as possible.
  • This must all support being deployed on-premise and on cloud platforms with minimal change.
  • Any bespoke software must be minimal and ideally just restricted to configuration of generic tools.
  • We must support user configuration of what is "important" to monitor in their clusters although with best practice defaults provided.
  • A simple and often upgrade pipeline to support frequent changes and updates to the solution which are then easy to roll out for users.

Quick Start

A simple quick start guide can be found here.

Documentation

Full documentation is provided in Asciidoc format within this repository and also served as HTML from the running container.

A developer and contribution guide is also available.

Feedback and support

Please refer to the support page here.

Local build for non-Couchbase Employees

# Checkout code
git clone [email protected]/couchbaselabs/observability

# Build image locally
make container -e OSS=true

# Run new image to test code changes
$ docker run --rm -d -p 8080:8080 --name cmos couchbase/observability-stack:v1

Local build for Couchbase Employees

First, checkout the code using repo. This will also checkout the upstream cbmultimanager repository:

# Checkout observability and upstream repo
$ mkdir cmos
$ cd cmos
$ repo init -u https://github.com/couchbase/manifest -m couchbase-observability-stack/master.xml
$ repo sync
$ cd couchbase-observability-stack

Now produce a local build. Running make container runs a script which packages everything in the repo into an image, which can deployed locally:

# Build image from code
$ make container

# If something has cached in your build and you want to rebuild from scratch, first run
$ make clean

# Run new image to test code changes
$ docker run --rm -d -p 8080:8080 --name cmos couchbase/observability-stack:v1

Release tagging and branching

Every release to DockerHub will include a matching identical Git tag here, i.e. the tags on https://hub.docker.com/r/couchbase/observability-stack/tags will have a matching tag in this repository that built them. Updates will be pushed to the main branch often and then tagged once released as a new image version. Tags will not be moved after release, even just for a documentation update - this should trigger a new release or just be available as the latest version on main.

The branching strategy is to minimize any branches other than main following the standard GitHub flow model.

observability's People

Contributors

alex-emery avatar babarkhandev avatar chandankumar4 avatar charlie-hayes avatar dependabot[bot] avatar elliotgoodwin avatar ingenthr avatar maria-robobug avatar markspolakovs avatar mileshong1 avatar patrick-stephens avatar princerachit avatar qiell avatar rajath-s avatar redm2 avatar shaashwatjain avatar shovanmaity avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.