README.md

squzy_go

Squzy_go is a package, which allows you to monitor you golang applications networking. It can be easily used via GRPC, gin and http requests.

Application setup

Before calling the API methods, it is necessary to setup application with two parameters:

import squzy_core "github.com/squzy/squzy_go/core"

//client - your http client, can be nil
app, err := squzy_core.CreateApplication(client, &squzy_core.Options{
		ApiHost:         "your squzy api host",
		ApplicationName: "your applciation name",
		ApplicationHost: "your applciation host",
	})

The AgentId parameter in options is not used yet.

GRPC integration

To use the squzy monitoring with GRPC, import:

import squzy_grpc "github.com/squzy/squzy_go/integrations/grpc"

Squzy monitoring allows you to use it on both client and server side. You don't need to duplicate it, so, if you use it on server side, you don't need to use it on client.

Squzy is working through interceptor interfaces provided by GRPC. There are two implementations: unary interceptor and stream interceptor. To use the interceptor you need to define application as it was mentioned above.

Client side usage:

conn, err := grpc.Dial(
    grpcUri, 
    squzy_grpc.NewClientUnaryInterceptor(application),
    squzy_grpc.NewClientStreamUnaryInterceptor(application)
)

Server side usage:

server := grpc.NewServer(
    squzy_grpc.NewServerUnaryInterceptor(application),
    squzy_grpc.NewServerStreamInterceptor(application),
)

Gin integration

To use the Squzy monitoring with GRPC, import:

import squzy_gin "github.com/squzy/squzy_go/integrations/gin"

Then you need to add Squzy middleware in your gin.Engine:

r := gin.New()
r.Use(squzy_gin.New(application))

http integration

To use Squzy monitoring with http, import:

import squzy_http "github.com/squzy/squzy_go/integrations/http"

The Squzy gor http working through the http.RoundTripper. You can provide you basic http.RoundTripper as parent parameter, or set it as nil.

client := &http.Client{
    Transport: NewRoundTripper(application, parent),
}

Additional methods

With Squzy core package you cna receive transaction from context:

import squzy_core "github.com/squzy/squzy_go/core"

parentTransaction := squzy_core.GetTransactionFromContext(ctx)

You can add your transaction to the other with (the third parameter is used to support interface):

transaction := parentTransaction.CreateTransaction(
    "transaction name",
    trType api.TransactionType,
    nil,
)

These methods can be combined:

transaction := squzy_core.GetTransactionFromContext(ctx).CreateTransaction(
    "transaction name",
    api.TransactionType_TRANSACTION_TYPE_GRPC,
    nil,
)

For manual transaction creating use:

transaction := squzy_core.New(
    "transaction name",
    api.TransactionType_TRANSACTION_TYPE_GRPC,
    application,
    parentTransaction,
)

For adding your transaction to context use:

ctxWithTrans := ContextWithTransaction(ctx, transaction)