Skip to content
This repository has been archived by the owner on May 26, 2022. It is now read-only.

XiaoMi/pegasus-go-client

Repository files navigation

pegasus-go-client

codecov

Go Report Card

PkgGoDev

This is the official go client for Apache Pegasus.

Requirement

Go1.12+.

Logging

By default pegasus-go-client logs to "./pegasus.log" on where your application runs. You can customize the logging rules as follows:

    // customize where the pegasus-go-client's logs reside.
    pegalog.SetLogger(pegalog.NewLogrusLogger(&pegalog.LogrusConfig{
        // rotation rules
        MaxSize:    500, // megabytes
        MaxAge:     5,   // days
        MaxBackups: 100,
        // log files location
        Filename:   "/home/work/myapp/log/pegasus.log",
    }))

To print the logs on screen:

pegalog.SetLogger(pegalog.StderrLogger)

We highly recommend you to enable client logging for debugging purpose. If you want support for other log destinations or log formats, please submit an issue for that.

Example

    import (
        "context"

        "github.com/XiaoMi/pegasus-go-client/pegasus"
    )

    cfg := Config{
        MetaServers: []string{"0.0.0.0:34601", "0.0.0.0:34602", "0.0.0.0:34603"},
    }

    client := NewClient(cfg)
    defer client.Close()

    tb, err := client.OpenTable(context.Background(), "temp")
    err = tb.Set(context.Background(), []byte("h1"), []byte("s1"), []byte("v1"))

For more examples please refer to example/.

TroubleShooting

Before using pegasus-go-client, it's recommended to configure GOBACKTRACE so as to generate coredump while program unexpectedly corrupts.

ulimit -c unlimited
export GOBACTRACE=crash