Skip to content
This repository has been archived by the owner on Jan 5, 2019. It is now read-only.

Commit

Permalink
update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
yedamao committed Feb 6, 2018
1 parent 084be28 commit de8fff6
Showing 1 changed file with 5 additions and 58 deletions.
63 changes: 5 additions & 58 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

Welcome to Mcqbeat.

Mcqbeat is based on [Beats](/~https://github.com/elastic/beats) ship memcacheq queue stats to elasticsearch.

Ensure that this folder is at the following location:
`${GOPATH}/src/github.com/yedamao/mcqbeat`

Expand All @@ -10,6 +12,7 @@ Ensure that this folder is at the following location:
### Requirements

* [Golang](https://golang.org/dl/) 1.7
* [Beats](/~https://github.com/elastic/beats) 6.0

### Init Project
To get running with Mcqbeat and also install the
Expand All @@ -19,16 +22,6 @@ dependencies, run the following command:
make setup
```

It will create a clean git history for each major step. Note that you can always rewrite the history if you wish before pushing your changes.

To push Mcqbeat in the git repository, run the following commands:

```
git remote set-url origin /~https://github.com/yedamao/mcqbeat
git push origin master
```

For further development, check out the [beat developer guide](https://www.elastic.co/guide/en/beats/libbeat/current/new-beat.html).

### Build

Expand Down Expand Up @@ -67,51 +60,5 @@ make coverage-report

The test coverage is reported in the folder `./build/coverage/`

### Update

Each beat has a template for the mapping in elasticsearch and a documentation for the fields
which is automatically generated based on `fields.yml` by running the following command.

```
make update
```


### Cleanup

To clean Mcqbeat source code, run the following commands:

```
make fmt
make simplify
```

To clean up the build directory and generated artifacts, run:

```
make clean
```


### Clone

To clone Mcqbeat from the git repository, run the following commands:

```
mkdir -p ${GOPATH}/src/github.com/yedamao/mcqbeat
git clone /~https://github.com/yedamao/mcqbeat ${GOPATH}/src/github.com/yedamao/mcqbeat
```


For further development, check out the [beat developer guide](https://www.elastic.co/guide/en/beats/libbeat/current/new-beat.html).


## Packaging

The beat frameworks provides tools to crosscompile and package your beat for different platforms. This requires [docker](https://www.docker.com/) and vendoring as described above. To build packages of your beat, run the following command:

```
make package
```

This will fetch and create all images required for the build process. The hole process to finish can take several minutes.
### Kibana Screenshots
![image](https://user-images.githubusercontent.com/8220938/35849582-14bb83f0-0b5d-11e8-95b6-43715a352cfb.png)

0 comments on commit de8fff6

Please sign in to comment.