Skip to content

Latest commit

 

History

History
91 lines (66 loc) · 3.62 KB

for-developers.md

File metadata and controls

91 lines (66 loc) · 3.62 KB

<- home page

For developers

If for any reason you need to extend or modify Logsearch-for-cloudfoundry functionallity please read this page carefully.

Before anything else, it makes sense to check Customization page for ways of extending Logsearch-for-cloudfoundry by using configuration options (without changing source code).

If you still feel like to change source code then please mind the following points:

  • When changing fields parsing consider default mappings. Make sure that default mappings are still applied after the changes in parsing.

  • Make sure that your custom parsing rules have no conflicts with default parsing rules. If necessary update related stuff such as Elasticsearch mappings, Kibana objects etc.

  • If you use Kibana authentication feature then make sure it works after you changed parsing (this feature relies on some fields, read about the feature for more details).

  • When developing parsing rules run tests for regression. Add new tests to check your custom logic.

Additionally, you can check out Troubleshooting page for tips on Logsearch deployment troubleshooting. It can be useful for you when testing your custom changes.

For questions / issues / contribution please follow Contribution section below.

Creating a dev release

Logsearch-for-cloudfoundry uses git submodules and BOSH package vendoring. If you have problems creating a release, check that you've updated the submodules and have a BOSH CLI version that supports vendoring (i.e., bosh --version is at least v2.0.36).

$ git clone --recursive https://github.com/cloudfoundry-community/logsearch-for-cloudfoundry
$ cd logsearch-for-cloudfoundry
$ bosh create-release
$ bosh -e your-director-name upload-release

Tests

Logsearch-config tests

Tests and build scripts are placed in logsearch-config directory. See Rakefile file for build tasks and bin/* for build scripts.

The project includes the following tests:

  • Unit tests for parsing snippets (test each parsing snippet)
  • Integration tests for snippets (test whole parsing config built from all snippets - as they used in prod)
  • JSON validation check
  • YAML validation check

Before running tests install dependencies:

cd src/logsearch-config
bin/install-dependencies

You don't need to execute it each time you run tests.

Then run tests with one of possible options:

all tests

bin/test

unit tests (all or specific)

bin/test utest

bin/test utest test/logstash-filters/snippets/platform-spec.rb

integartion tests (all or specific)

bin/test itest

bin/test itest test/logstash-filters/it/app-it-spec.rb

validation checks (json or yaml)

bin/test json

bin/test yaml
Smoke tests

There are also smoke tests running as a BOSH job. Smoke tests are hosted in a separate repo.

Contribution

If you detect any issue please submit it here in GitHub so that we can be aware of it and fix it. If you are ready to contribute you are welcome with pull requests.

If you have any questions - please contact us on GitHub.


<- prev page