expipe

KO | EN

gitlite — search

#python #typescript #llm #machine-learning #deep-learning #macos #java #windows #awesome #cli #kubernetes #mcp #openai #open-source

(★ 10)

Ship your expvar metrics to elasticsearch

expipe Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Expipe

[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
[![GoDoc](https://godoc.org/github.com/arsham/expipe?status.svg)](http://godoc.org/github.com/arsham/expipe)
[![Build Status](https://travis-ci.org/arsham/expipe.svg?branch=master)](https://travis-ci.org/arsham/expipe)
[![Coverage Status](https://codecov.io/gh/arsham/expipe/branch/master/graph/badge.svg)](https://codecov.io/gh/arsham/expipe)
[![Go Report Card](https://goreportcard.com/badge/github.com/arsham/expipe)](https://goreportcard.com/report/github.com/arsham/expipe)
[![Codacy Badge](https://api.codacy.com/project/badge/Grade/6cc048fae4ba4129b05226308a0bd7e9)](https://www.codacy.com/app/arsham/expipe?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=arsham/expipe&amp;utm_campaign=Badge_Grade)

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

1. [Features](#features)
    * [Upcoming Features](#upcoming-features)
2. [Installation](#installation)
3. [Kibana](#kibana)
    * [Importing Dashboard](#importing-dashboard)
4. [Usage](#usage)
    * [With Flags](#with-flags)
    * [Advanced](#advanced)
5. [LICENSE](#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](./configs/dashboard.json).
* 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 are welcome! Please
refer to golang's [expvar documentation][expvar] for more information. Screen
shots can be found in [this](./docs/SCREENSHOTS.md) document. Here is an
example:

![Colored](http://i.imgur.com/6U2hxlp.png)

### Upcoming Features

* Read from log files.
* Use as a third-party package.
* Record to more repositories:
    * InfluxDB
    * Log files

## Installation

I will provide a docker image soon, but for now it needs to be installed. You
need golang >= 1.7 and [glide][glide] installed. Simply do:

```bash
go get github.com/arsham/expipe
cd $GOPATH/src/github.com/arsham/expipe
glide install
go install
```

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

```bash
docker volume create expipe
docker run -d --name expipe --restart always --ulimit nofile=98304:98304 -v expipe:/usr/share/elasticsearch/data -e ES_JAVA_OPTS='-Xms10G -Xmx10G' -e "xpack.security.enabled=false" -e "xpack.monitoring.enabled=true" -e "xpack.graph.enabled=true" -e "xpack.watcher.enabled=false" -p 9200:9200 -e "http.cors.enabled=true" -e 'http.cors.allow-origin=*' docker.elastic.co/elasticsearch/elasticsearch:5.5.3
docker run -d --name kibana --restart always -p 80:5601 --link expipe:elasticsearch docker.elastic.co/kibana/kibana:5.5.3
```

## Kibana

Access [the dashboard](http://localhost) (or any other ports you have exposed
kibana to, notice the `-p:80:5601` above), and enter `expipe` 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](./configs/dashboard.json) file and you're done!

One of the provided dashboards shows the expipe'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:

```bash
expipe -reader="localhost:1234/debug/vars" -recorder="localhost:9200"
```

For more flags run:
```bash
expipe -h
```

### Advanced

Please refer to [this](./docs/RECIPES.md) 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](./LICENSE) file.

`Enjoy!`

[expvar]: https://golang.org/pkg/expvar/
[glide]: https://github.com/Masterminds/glide
[elasticsearch]: https://github.com/elastic/elasticsearch
[kibana]: https://github.com/elastic/kibana

expipe

expipe Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

expipe

expipe Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README