forked from elastic/beats
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Updated README and CONTRIBUTING files
* Removed badges from the sub-folders README files * Refreshed the libbeat README * Added a new global CONTRIBUTING.md file * Drastically simplified the CONTRIBUTING files from the individual Beats, or removed them completely if they didn't add new information when compared to the global one.
- Loading branch information
Tudor Golubenco
committed
Dec 2, 2015
1 parent
9fd67b4
commit 06b932b
Showing
11 changed files
with
120 additions
and
295 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,83 @@ | ||
| # Contributing to Beats | ||
|
|
||
| The Beats are open source and we love to receive contributions from our | ||
| community — you! | ||
|
|
||
| There are many ways to contribute, from writing tutorials or blog posts, | ||
| improving the documentation, submitting bug reports and feature requests or | ||
| writing code for implementing a whole new protocol. | ||
|
|
||
| If you have a bugfix or new feature that you would like to contribute, please | ||
| start by opening a topic on the [forums](https://discuss.elastic.co/c/beats). | ||
| It may be that somebody is already working on it, or that there are particular | ||
| issues that you should know about before implementing the change. | ||
|
|
||
| We enjoy working with contributors to get their code accepted. There are many | ||
| approaches to fixing a problem and it is important to find the best approach | ||
| before writing too much code. | ||
|
|
||
| The process for contributing to any of the Elastic repositories is similar. | ||
|
|
||
| ## Contribution Steps | ||
|
|
||
| 1. Please make sure you have signed our [Contributor License | ||
| Agreement](https://www.elastic.co/contributor-agreement/). We are not | ||
| asking you to assign copyright to us, but to give us the right to distribute | ||
| your code without restriction. We ask this of all contributors in order to | ||
| assure our users of the origin and continuing existence of the code. You | ||
| only need to sign the CLA once. | ||
| 2. Send a pull request! Push your changes to your fork of the repository and | ||
| [submit a pull | ||
| request](https://help.github.com/articles/using-pull-requests). In the pull | ||
| request, describe what your changes do and mention any bugs/issues related | ||
| to the pull request. | ||
|
|
||
|
|
||
| ## Adding a new Beat | ||
|
|
||
| If you want to create a new Beat, please read our [developer | ||
| guide](https://www.elastic.co/guide/en/beats/libbeat/current/new-beat.html). | ||
| You don't need to submit the code to this repository. Most new Beats start in | ||
| their own repository and just make use of the libbeat packages. After you have | ||
| a working Beat that you'd like to share with others, open a PR to add it to our | ||
| list of [community | ||
| Beats](https://github.com/tsg/beats-onerepo/blob/master/libbeat/docs/communitybeats.asciidoc). | ||
|
|
||
| ## Setting up your dev environment | ||
|
|
||
| The Beats are Go programs, so install the latest version of | ||
| [golang](http://golang.org/) if you don't have it already. | ||
|
|
||
| The location where you clone is important. Please clone under the source | ||
| directory of your `GOPATH`. If you don't have `GOPATH` already set, you can | ||
| simply set it to your home directory (`export GOPATH=$HOME`). | ||
|
|
||
| $ mkdir -p $GOPATH/src/github.com/elastic | ||
| $ cd $GOPATH/src/github.com/elastic | ||
| $ git clone https://github.com/elastic/beats.git | ||
|
|
||
| Then you can compile a particular Beat by using the Makefile. For example, for | ||
| Packetbeat: | ||
|
|
||
| $ cd beats/packetbeat | ||
| $ make | ||
|
|
||
| Some of the Beats might have extra development requirements, in which case a | ||
| CONTRIBUTING.md file is find in the Beat directory. | ||
|
|
||
| You can run the whole testsuite with the following command: | ||
|
|
||
| # make testsuite | ||
|
|
||
| ## Dependencies | ||
|
|
||
| The Beats project is using the [Go 1.5 vendor | ||
| experiment](https://docs.google.com/document/d/1Bz5-UB7g2uPBdOx-rw5t9MxJwkfpx90cqG9AFL0JAYo/edit) | ||
| for its dependencies. This means the Go dependencies code is copied under the | ||
| `vendor/` directory and committed into source control. | ||
|
|
||
| To manage the `vendor/` folder we use | ||
| [glide](https://github.com/Masterminds/glide), which uses | ||
| [glide.yaml](glide.yaml) as a manifest file for the dependencies. Please see | ||
| the glide documentation on how to add or update vendored dependencies. | ||
|
|
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,30 +1,19 @@ | ||
| [](http://build-eu-00.elastic.co/job/libbeat/) | ||
| [](https://travis-ci.org/elastic/libbeat) | ||
| [](http://codecov.io/github/elastic/libbeat?branch=master) | ||
| # libbeat - Framework for building the Beats | ||
|
|
||
|
|
||
| libbeat | ||
| ======= | ||
|
|
||
| The Beats are a collection of daemons that ship data from your servers to | ||
| Elasticsearch. Read more about Beats on the | ||
| [elastic.co](https://www.elastic.co/products/beats) website. | ||
|
|
||
| The first Beat is [Packetbeat](https://github.com/elastic/packetbeat), a tool | ||
| that captures and decodes the traffic between your servers and inserts metadata | ||
| about each request-response pair into Elasticsearch. Other Beats will follow, | ||
| possible examples being: a Beat for reading and shipping log files (Filebeat), a | ||
| Beat for various OS level metrics (Metricbeat), a Beat for real user monitoring | ||
| (Rumbeat), etc. | ||
|
|
||
| libbeat is the repository containing the common Go packages for all Beats. It | ||
| is Apache licensed and actively maintained by the Elastic team. | ||
| libbeat is a Go library containing the common packages for all the | ||
| [Beats](https://www.elastic.co/products/beats). | ||
| It is Apache licensed and actively maintained by the Elastic team. | ||
|
|
||
| If you want to create a new project that reads some sort of operational data | ||
| and ships it to Elasticsearch, we suggest you make use of this library. Please | ||
| open a topic on the [forums](https://discuss.elastic.co/c/beats/libbeat) and | ||
| start by reading our [CONTRIBUTING](../CONTRIBUTING.md) file. We also have a | ||
| [developer | ||
| guide](https://www.elastic.co/guide/en/beats/libbeat/current/new-beat.html) to | ||
| help you with the creation of new Beats. | ||
|
|
||
| Please also open a topic on the [forums](https://discuss.elastic.co/c/beats/libbeat) and | ||
| we'll help you get started. | ||
|
|
||
| If you would like to contribute to libbeat or create a new Beat, please read | ||
| also the [CONTRIBUTING.md](CONTRIBUTING.md) file. | ||
| To see the Beats that are built on top of this library, please see the list | ||
| from the main [README](../README.md) file and the list of [community | ||
| Beats](https://www.elastic.co/guide/en/beats/libbeat/master/community-beats.html). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,57 +1,11 @@ | ||
| # Contributing to Packetbeat | ||
|
|
||
| Packetbeat is an open source project and we love to receive contributions from | ||
| our community — you! | ||
|
|
||
| There are many ways to contribute, from writing tutorials | ||
| or blog posts, improving the documentation, submitting bug reports and feature | ||
| requests or writing code for implementing a whole new protocol. | ||
|
|
||
| If you have a bugfix or new feature that you would like to contribute to | ||
| Packetbeat, please start by opening a topic on the | ||
| [forums](https://discuss.elastic.co/c/beats/packetbeat). It may be that | ||
| somebody is already working on it, or that there are particular issues that you | ||
| should know about before implementing the change. | ||
|
|
||
| We enjoy working with contributors to get their code accepted. There are many | ||
| approaches to fixing a problem and it is important to find the best approach | ||
| before writing too much code. | ||
|
|
||
| The process for contributing to any of the Elastic repositories is similar. | ||
|
|
||
| ## Contribution Steps | ||
|
|
||
| *Prereq:* libpcap-dev (deb) || libpcap-devel (rpm) should be present in your system. | ||
|
|
||
| 1. Test your changes! Run the test suite (`make test`) | ||
| 2. Please make sure you have signed our [Contributor License | ||
| Agreement](https://www.elastic.co/contributor-agreement/). We are not | ||
| asking you to assign copyright to us, but to give us the right to distribute | ||
| your code without restriction. We ask this of all contributors in order to | ||
| assure our users of the origin and continuing existence of the code. You | ||
| only need to sign the CLA once. | ||
| 3. Send a pull request! Push your changes to your fork of the repository and | ||
| [submit a pull | ||
| request](https://help.github.com/articles/using-pull-requests). In the pull | ||
| request, describe what your changes do and mention any bugs/issues related | ||
| to the pull request. | ||
|
|
||
|
|
||
| ## Compiling Packetbeat | ||
|
|
||
| Packetbeat is a Go program, so install [golang](http://golang.org/) if you | ||
| don't have it already. The only other mandatory dependency is `libpcap` which | ||
| often is pre-installed on your operating system. | ||
|
|
||
| The location where you clone is important. Please clone under the source | ||
| directory of your `GOPATH`. If you don't have `GOPATH` already set, you can | ||
| simply set it to your home directory (`export GOPATH=$HOME`). | ||
|
|
||
| $ mkdir -p $GOPATH/src/github.com/elastic | ||
| $ cd $GOPATH/src/github.com/elastic | ||
| $ git clone https://github.com/elastic/packetbeat.git | ||
|
|
||
| and then compile it with: | ||
|
|
||
| $ cd packetbeat | ||
| $ make | ||
| Please see the main [CONTRIBUTING](../CONTRIBUTING.md) file, and consider the | ||
| following notes: | ||
|
|
||
| * If you are planning to add a new protocol, please read our [developer guide | ||
| for adding new | ||
| protocols](https://www.elastic.co/guide/en/beats/packetbeat/current/_developer_guide_adding_a_new_protocol.html) | ||
| * Packetbeat uses Cgo, so in addition to having Go installed you need a C | ||
| compiler | ||
| * Packetbeat depends on libpcap. You need to install libpcap-dev on Debian | ||
| based systems or libpcap-devel on RedHat based systems. On Windows, you | ||
| need winpcap. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.