expvastic

README

Expvastic

Expvastic can record your application's metrics in ElasticSearch and you can view them with kibana. It can read from any applications (written in any language) that provides metrics in json format.

1. Features
2. Installation
3. Kibana

• Importing Dashboard

1. Usage

• With Flags
• Advanced

1. LICENSE

Features

• Very lightweight and fast.
• Can read from multiple input.
• Can ship the metrics to multiple databases.
• Shows memory usages and GC pauses of the apps.
• Metrics can be aggregated for different apps (with elasticsearch's type system).
• A kibana dashboard is also provided here.
• Maps values how you define them. For example you can change bytes to megabytes.
• Benchmarks are included.

There are TODO items in the issue section. Feature requests welcome!

Please refer to golang's expvar documentation for more information.

Screenshots can be found in this document. Here is an example:

Installation

I will provide a docker image soon, but for now it needs to be installed. You need golang 1.7 (I haven't tested it with older versions, but they should be fine) and glide installed. Simply do:

go get github.com/arsham/expvastic
cd $GOPATH/src/github.com/arsham/expvastic
glide install
go install ./cmd/expvastic

You also need elasticsearch and kibana, here is a couple of docker images you can start with:

docker run -d --restart always --name expvastic -p 9200:9200 --ulimit nofile=98304:98304 -v "/path/to/somewhere/expvastic":/usr/share/elasticsearch/data elasticsearch
docker run -d --restart always --name kibana -p 80:5601 --link expvastic:elasticsearch -p 5601:5601 kibana

Kibana

Access the dashboard (or any other ports you have exposed kibana to, notice the -p:80:5601 above), and enter expvastic as Index name or pattern in management section.

Select @timestamp for Time-field name. In case it doesn't show up, click Index contains time-based events twice, it will provide you with the timestamp. Then click on create button.

Importing Dashboard

Go to Saved Objects section of management, and click on the import button. Upload this file and you're done!

One of the provided dashboards shows the expvastic's own metrics, and you can use the other one for everything you have defined in the configuration file.

Usage

With Flags

With this method you can only have one reader and ship to one recorder. Consider the next section for more flexible setup. The defaults are sensible to use, you only need to point the app to two endpoints, and it does the rest for you:

expvastic -reader="localhost:1234/debug/vars" -recorder="localhost:9200"

For more flags run:

expvastic -h

Advanced

Please refer to this document for advanced configuration and mappings.

LICENSE

Use of this source code is governed by the Apache 2.0 license. License that can be found in the LICENSE file.

Enjoy!

Documentation

Overview

Package expvastic can read from any endpoints that provides expvar data and ships them to elasticsearch. You can inspect the metrics with kibana.

Please refer to golang's expvar documentation for more information. Installation guides can be found on github page: https://github.com/arsham/expvastic

At the heart of this package, there is Engine. It acts like a glue between a Reader and a Recorder. Messages are transfered in a package called DataContainer, which is a list of DataType objects.

Here an example configuration, save it somewhere (let's call it expvastic.yml for now):

settings:
    log_level: info

readers:                           # You can specify the applications you want to show the metrics
    FirstApp:                      # service name
        type: expvar               # the type of reader. More to come soon!
        type_name: AppVastic       # this will be the _type in elasticsearch
        endpoint: localhost:1234   # where the application
        routepath: /debug/vars     # the endpoint that app provides the metrics
        interval: 500ms            # every half a second, it will collect the metrics.
        timeout: 3s                # in 3 seconds it gives in if the application is not responsive
        backoff: 10                # after 10 times the application didn't response, it will stop reading from it
    AnotherApplication:
        type: expvar
        type_name: this_is_awesome
        endpoint: localhost:1235
        routepath: /metrics
        interval: 500ms
        timeout: 13s
        backoff: 10

recorders:                         # This section is where the data will be shipped to
    main_elasticsearch:
        type: elasticsearch        # the type of recorder. More to come soon!
        endpoint: 127.0.0.1:9200
        index_name: expvastic
        timeout: 8s
        backoff: 10
    the_other_elasticsearch:
        type: elasticsearch
        endpoint: 127.0.0.1:9201
        index_name: expvastic
        timeout: 18s
        backoff: 10

routes:                            # You can specify metrics of which application will be recorded in which target
    route1:
        readers:
            - FirstApp
        recorders:
            - main_elasticsearch
    route2:
        readers:
            - FirstApp
            - AnotherApplication
        recorders:
            - main_elasticsearch
    route3:                      # Yes, you can have multiple!
        readers:
            - AnotherApplication
        recorders:
            - main_elasticsearch
            - the_other_elasticsearch

Then run the application:

expvasyml -c expvastic.yml

You can mix and match the routes, but the engine will choose the best setup to achive your goal without duplicating the results. For instance assume you set the routes like this:

readers:
    app_0:
    app_1:
    app_2:
recorders:
    elastic_0:
    elastic_1:
    elastic_2:
    elastic_3:
routes:
    route1:
        readers:
            - app_0
            - app_2
        recorders:
            - elastic_1
    route2:
        readers:
            - app_0
        recorders:
            - elastic_1
            - elastic_2
            - elastic_3
    route2:
        readers:
            - app_1
            - app_2
        recorders:
            - elastic_1
            - elastic_0

Expvastic creates three engines like so:

Data from app_0 will be shipped to: elastic_1, elastic_2 and elastic_3
Data from app_1 will be shipped to: elastic_1 and, elastic_0
Data from app_2 will be shipped to: elastic_1 and, elastic_0

You can change the numbers to your liking:

gc_types:                      # These inputs will be collected into one list and zero values will be removed
    memstats.PauseEnd
    memstats.PauseNs

memory_bytes:                   # These values will be transoformed from bytes
    StackInuse: mb              # To MB
    memstats.Alloc: gb          # To GB

To run the tests for the codes, in the root of the application run:

go test $(glide nv)

Or for testing readers:

go test ./readers

To show the coverage, se this gist https://gist.github.com/arsham/f45f7e7eea7e18796bc1ed5ced9f9f4a. Then run:

goverall

It will open a browser tab and show you the coverage.

To run all benchmarks:

go test $(glide nv) -run=^$ -bench=.

For showing the memory and cpu profiles, on each folder run:

BASENAME=$(basename $(pwd))
go test -run=^$ -bench=. -cpuprofile=cpu.out -benchmem -memprofile=mem.out
go tool pprof -pdf $BASENAME.test cpu.out > cpu.pdf && open cpu.pdf
go tool pprof -pdf $BASENAME.test mem.out > mem.pdf && open mem.pdf

Use of this source code is governed by the Apache 2.0 license. License that can be found in the LICENSE file.

Index

• Variables
• func StartEngines(ctx context.Context, log logrus.FieldLogger, confMap *config.ConfMap) (chan struct{}, error)
• type Engine
  • func NewWithConfig(ctx context.Context, log logrus.FieldLogger, ...) (*Engine, error)
  • func NewWithReadRecorder(ctx context.Context, logger logrus.FieldLogger, recResChan int, ...) (*Engine, error)
  • func (e *Engine) Name() string
  • func (e *Engine) Start() <-chan struct{}
  • func (e *Engine) Stop()

Examples

• Engine (SendingJobs)

Variables

var (
	// ErrEmptyRecName is for when the recorder's name is an empty string.
	ErrEmptyRecName = fmt.Errorf("recorder name empty")

	// ErrDupRecName is for when there are two recorders with the same name.
	ErrDupRecName = fmt.Errorf("recorder name empty")
)

Functions

func StartEngines

func StartEngines(ctx context.Context, log logrus.FieldLogger, confMap *config.ConfMap) (chan struct{}, error)

StartEngines creates some Engines and returns a channel that closes it when it's done its work. For each routes, we need one engine that has one reader and writes to multiple recorders. This is because:

1 - Readers should not intercept each other by engaging the recorders.
2 - When a reader goes out of scope, we can safely stop the recorders.

When a recorder goes out of scope, the Engine stops sending to that recorder.

Types

type Engine

type Engine struct {
	// contains filtered or unexported fields
}

Engine represents an engine that receives information from readers and ships them to recorders. The Engine is allowed to change the index and type names at will. When the context times out or canceled, the engine will close the the job channels by calling the Stop method. Note that we could create a channel and distribute the recorders payload, but we didn't because there is no way to find out which recorder errors right after the payload has been sent. IMPORTANT: the readers should not close their streams, I am closing them here.

Example (SendingJobs)

package main

import (
	"bytes"
	"context"
	"fmt"
	"io"
	"net/http"
	"net/http/httptest"
	"time"

	"github.com/arsham/expvastic"
	"github.com/arsham/expvastic/communication"
	"github.com/arsham/expvastic/lib"
	"github.com/arsham/expvastic/reader"
	"github.com/arsham/expvastic/recorder"
)

func main() {
	var res *reader.ReadJobResult
	log := lib.DiscardLogger()
	ctx, cancel := context.WithCancel(context.Background())
	desire := `{"the key": "is the value!"}`
	recorded := make(chan string)

	redTs := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
		io.WriteString(w, desire)
	}))
	defer redTs.Close()

	recTs := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
		recorded <- "Job was recorded"
	}))
	defer recTs.Close()

	jobChan := make(chan context.Context)
	errorChan := make(chan communication.ErrorMessage)
	resultChan := make(chan *reader.ReadJobResult)
	payloadChan := make(chan *recorder.RecordJob)

	ctxReader := reader.NewCtxReader(redTs.URL)
	red, _ := reader.NewSimpleReader(log, ctxReader, jobChan, resultChan, errorChan, "reader_example", "typeName", 10*time.Millisecond, 10*time.Millisecond)
	rec, _ := recorder.NewSimpleRecorder(ctx, log, payloadChan, errorChan, "reader_example", recTs.URL, "intexName", 10*time.Millisecond)
	redDone := red.Start(ctx)
	recDone := rec.Start(ctx)

	cl, err := expvastic.NewWithReadRecorder(ctx, log, 0, errorChan, red, rec)
	fmt.Println("Engine creation success:", err == nil)
	clDone := cl.Start()

	select {
	case red.JobChan() <- communication.NewReadJob(ctx):
		fmt.Println("Just sent a job request")
	case <-time.After(time.Second):
		panic("expected the reader to recive the job, but it blocked")
	}
	fmt.Println(<-recorded)

	select {
	case res = <-red.ResultChan():
		fmt.Println("Job operation success")
	case <-time.After(5 * time.Second): // Should be more than the interval, otherwise the response is not ready yet
		panic("expected to recive a data back, nothing recieved")
	}

	select {
	case <-errorChan:
		panic("expected no errors")
	case <-time.After(10 * time.Millisecond):
		fmt.Println("No errors reported!")
	}

	buf := new(bytes.Buffer)
	buf.ReadFrom(res.Res)
	fmt.Println("Reader just received payload:", buf.String())

	cancel()
	_, open := <-redDone
	fmt.Println("Reader closure:", !open)

	_, open = <-recDone
	fmt.Println("Recorder closure:", !open)

	_, open = <-clDone
	fmt.Println("Client closure:", !open)

}

Output:

Engine creation success: true
Just sent a job request
Job was recorded
Job operation success
No errors reported!
Reader just received payload: {"the key": "is the value!"}
Reader closure: true
Recorder closure: true
Client closure: true

func NewWithConfig

func NewWithConfig(
	ctx context.Context,
	log logrus.FieldLogger,
	readChanBuff,
	readResChanBuff,
	recChanBuff,
	recResChan int,
	red config.ReaderConf,
	recorders ...config.RecorderConf,
) (*Engine, error)

NewWithConfig instantiates reader and recorders from the configurations. readChanBuff, readResChanBuff, recChanBuff, recResChan are the channel buffer amount. Please refer to benchmarks how to choose the best values.

func NewWithReadRecorder

func NewWithReadRecorder(
	ctx context.Context,
	logger logrus.FieldLogger,
	recResChan int,
	errorChan <-chan communication.ErrorMessage,
	red reader.DataReader,
	recs ...recorder.DataRecorder,
) (*Engine, error)

NewWithReadRecorder creates an instance with already made reader and recorders. It spawns one reader and streams its payload to all recorders. Returns an error if there are recorders with the same name, or any of them have no name.

func (*Engine) Name

func (e *Engine) Name() string

Name shows the name identifier for this engine

func (*Engine) Start

func (e *Engine) Start() <-chan struct{}

Start begins pulling the data from DataReader and chips them to DataRecorder. When the context is canceled or timed out, the engine closes all job channels, causing the readers and recorders to stop.

func (*Engine) Stop

func (e *Engine) Stop()

Stop closes the job channels