Code Monkey home page Code Monkey logo

pubsubbeat's Introduction

Build Status Go Report Card License

Pubsubbeat

Pubsubbeat is an elastic Beat for Google Cloud Pub/Sub. This Beat subscribes to a topic and ingest messages.

The main motivation behind the development of this plugin is to ingest Stackdriver Logs via the Exported Logs feature and send them directly to Elasticsearch ingest nodes.

This is not an officially supported Google product.

Getting Started with Pubsubbeat

Requirements

Build

To build the binary for Pubsubbeat run the command below. This will generate a binary in the same directory with the name pubsubbeat.

make

Run

To run Pubsubbeat with debugging output enabled, run:

./pubsubbeat -c pubsubbeat.yml -e -d "*"

Test

To test Pubsubbeat, run the following command:

make testsuite

alternatively:

make unit-tests
make system-tests
make integration-tests
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 Pubsubbeat 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 Pubsubbeat from the git repository, run the following commands:

mkdir -p ${GOPATH}/src/github.com/GoogleCloudPlatform/pubsubbeat
git clone https://github.com/GoogleCloudPlatform/pubsubbeat ${GOPATH}/src/github.com/GoogleCloudPlatform/pubsubbeat

For further development, check out the beat developer guide.

Packaging

The beat frameworks provides tools to crosscompile and package your beat for different platforms. This requires docker 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.

pubsubbeat's People

Contributors

rosbo avatar josephlewis42 avatar

Watchers

ed00m:th3d00m avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.