Skip to content

Commit

Permalink
Merge pull request #142 from Feuerlabs/uw-remove-folsom
Browse files Browse the repository at this point in the history
Remove folsom and bear dependencies
  • Loading branch information
uwiger authored Feb 17, 2024
2 parents 8dabf3f + 8b6907f commit 2582977
Show file tree
Hide file tree
Showing 37 changed files with 138 additions and 1,029 deletions.
22 changes: 22 additions & 0 deletions .github/workflows/main.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
name: Exometer CI

on: [pull_request, push]

jobs:
linux:
name: Test on OTP ${{ matrix.otp_version }} and ${{ matrix.os }}
runs-on: ${{ matrix.os }}

strategy:
matrix:
otp_version: [24, 25, 26]
os: [ubuntu-latest]

container:
image: erlang:${{ matrix.otp_version }}

steps:
- name: Checkout
uses: actions/checkout@v4
- name: CI tests
run: make ci
13 changes: 0 additions & 13 deletions .travis.yml

This file was deleted.

36 changes: 3 additions & 33 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

Copyright (c) 2014 Basho Technologies, Inc. All Rights Reserved.

__Version:__ Oct 30 2018 13:49:09
__Version:__ Feb 16 2024 16:48:36

__Authors:__ Ulf Wiger ([`[email protected]`](mailto:[email protected])), Magnus Feuer ([`[email protected]`](mailto:[email protected])).

Expand Down Expand Up @@ -48,8 +48,7 @@ optional packages, both users and developers.
4. [exometer_histogram (probe)](https://github.com/Feuerlabs/exometer_core/blob/master/doc/README.md#exometer_histogram_(probe))
5. [exometer_uniform (probe)](https://github.com/Feuerlabs/exometer_core/blob/master/doc/README.md#exometer_uniform_(probe))
6. [exometer_spiral (probe)](https://github.com/Feuerlabs/exometer_core/blob/master/doc/README.md#exometer_spiral_(probe))
7. [exometer_folsom [entry]](https://github.com/Feuerlabs/exometer_core/blob/master/doc/README.md#exometer_folsom_[entry])
8. [exometer_function [entry]](https://github.com/Feuerlabs/exometer_core/blob/master/doc/README.md#exometer_function_[entry])
7. [exometer_function [entry]](https://github.com/Feuerlabs/exometer_core/blob/master/doc/README.md#exometer_function_[entry])
3. [Built in Reporters](https://github.com/Feuerlabs/exometer_core/blob/master/doc/README.md#Built_in_Reporters)
1. [exometer_report_tty](https://github.com/Feuerlabs/exometer_core/blob/master/doc/README.md#exometer_report_tty)
4. [Instrumenting Erlang code](https://github.com/Feuerlabs/exometer_core/blob/master/doc/README.md#Instrumenting_Erlang_code)
Expand Down Expand Up @@ -137,10 +136,6 @@ as a uniform distribution or a regular histogram.
The various outputs from these entries are reported as data points
under the given metric.

An entry can also interface external analytics packages.
`exometer_folsom`, for example, integrates with the
`folsom_metrics` package found at [`https://github.com/boundary/folsom`](https://github.com/boundary/folsom).


#### <a name="Probe">Probe</a> ####

Expand Down Expand Up @@ -292,17 +287,6 @@ The grand total of all values received during the lifetime of the
probe is also available.


#### <a name="exometer_folsom_[entry]">exometer_folsom [entry]</a> ####

The folsom entry integrates with the folsom metrics package provided
by the boundary repo at github. Updated values sent to the folsom entry
can be forwarded to folsom's counter, histogram, duration, meter,
and spiral.

Folsom integration is provided as a backup. New code using Exometer Core
should use the native probes that duplicate folsom.


#### <a name="exometer_function_[entry]">exometer_function [entry]</a> ####

The function entry allows for a simple caller-supplied function to be
Expand Down Expand Up @@ -350,10 +334,6 @@ Note that dependent applications need to be started first. On newer OTP versions

For testing, you can also use [`exometer:start/0`](https://github.com/Feuerlabs/exometer_core/blob/master/doc/exometer.md#start-0).

If you make use of e.g. folsom metrics, you also need to start `folsom`.
Exometer Core will not do that automatically, nor does it contain an
application dependency for it.

See [Configuring Exometer Core](https://github.com/Feuerlabs/exometer_core/blob/master/doc/README.md#Configuring_Exometer_Core) for details on configuration data
format.

Expand Down Expand Up @@ -521,10 +501,7 @@ Below is an example, from `exometer_core/priv/app.config`:
{['_'], function , [{module, exometer_function}]},
{['_'], counter , [{module, exometer}]},
{['_'], histogram, [{module, exometer_histogram}]},
{['_'], spiral , [{module, exometer_spiral}]},
{['_'], duration , [{module, exometer_folsom}]},
{['_'], meter , [{module, exometer_folsom}]},
{['_'], gauge , [{module, exometer_folsom}]}
{['_'], spiral , [{module, exometer_spiral}]}
]}
]}
```
Expand All @@ -539,9 +516,6 @@ exometer.template.function.module = exometer_function
exometer.template.counter.module = exometer
exometer.template.histogram.module = exometer_histogram
exometer.template.spiral.module = exometer_spiral
exometer.template.duration.module = exometer_folsom
exometer.template.meter.module = exometer_folsom
exometer.template.gauge.module = exometer_folsom
```


Expand Down Expand Up @@ -728,19 +702,15 @@ processing is complete.


<table width="100%" border="0" summary="list of modules">
<tr><td><a href="https://github.com/Feuerlabs/exometer_core/blob/master/doc/exo_montest.md" class="module">exo_montest</a></td></tr>
<tr><td><a href="https://github.com/Feuerlabs/exometer_core/blob/master/doc/exometer.md" class="module">exometer</a></td></tr>
<tr><td><a href="https://github.com/Feuerlabs/exometer_core/blob/master/doc/exometer_admin.md" class="module">exometer_admin</a></td></tr>
<tr><td><a href="https://github.com/Feuerlabs/exometer_core/blob/master/doc/exometer_alias.md" class="module">exometer_alias</a></td></tr>
<tr><td><a href="https://github.com/Feuerlabs/exometer_core/blob/master/doc/exometer_cache.md" class="module">exometer_cache</a></td></tr>
<tr><td><a href="https://github.com/Feuerlabs/exometer_core/blob/master/doc/exometer_cpu.md" class="module">exometer_cpu</a></td></tr>
<tr><td><a href="https://github.com/Feuerlabs/exometer_core/blob/master/doc/exometer_duration.md" class="module">exometer_duration</a></td></tr>
<tr><td><a href="https://github.com/Feuerlabs/exometer_core/blob/master/doc/exometer_entry.md" class="module">exometer_entry</a></td></tr>
<tr><td><a href="https://github.com/Feuerlabs/exometer_core/blob/master/doc/exometer_folsom.md" class="module">exometer_folsom</a></td></tr>
<tr><td><a href="https://github.com/Feuerlabs/exometer_core/blob/master/doc/exometer_folsom_monitor.md" class="module">exometer_folsom_monitor</a></td></tr>
<tr><td><a href="https://github.com/Feuerlabs/exometer_core/blob/master/doc/exometer_function.md" class="module">exometer_function</a></td></tr>
<tr><td><a href="https://github.com/Feuerlabs/exometer_core/blob/master/doc/exometer_histogram.md" class="module">exometer_histogram</a></td></tr>
<tr><td><a href="https://github.com/Feuerlabs/exometer_core/blob/master/doc/exometer_igor.md" class="module">exometer_igor</a></td></tr>
<tr><td><a href="https://github.com/Feuerlabs/exometer_core/blob/master/doc/exometer_info.md" class="module">exometer_info</a></td></tr>
<tr><td><a href="https://github.com/Feuerlabs/exometer_core/blob/master/doc/exometer_probe.md" class="module">exometer_probe</a></td></tr>
<tr><td><a href="https://github.com/Feuerlabs/exometer_core/blob/master/doc/exometer_proc.md" class="module">exometer_proc</a></td></tr>
Expand Down
39 changes: 3 additions & 36 deletions doc/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

Copyright (c) 2014 Basho Technologies, Inc. All Rights Reserved.

__Version:__ Oct 30 2018 13:49:09
__Version:__ Feb 16 2024 16:48:36

__Authors:__ Ulf Wiger ([`[email protected]`](mailto:[email protected])), Magnus Feuer ([`[email protected]`](mailto:[email protected])).

Expand Down Expand Up @@ -48,8 +48,7 @@ optional packages, both users and developers.
4. [exometer_histogram (probe)](#exometer_histogram_(probe))
5. [exometer_uniform (probe)](#exometer_uniform_(probe))
6. [exometer_spiral (probe)](#exometer_spiral_(probe))
7. [exometer_folsom [entry]](#exometer_folsom_[entry])
8. [exometer_function [entry]](#exometer_function_[entry])
7. [exometer_function [entry]](#exometer_function_[entry])
3. [Built in Reporters](#Built_in_Reporters)
1. [exometer_report_tty](#exometer_report_tty)
4. [Instrumenting Erlang code](#Instrumenting_Erlang_code)
Expand Down Expand Up @@ -137,10 +136,6 @@ as a uniform distribution or a regular histogram.
The various outputs from these entries are reported as data points
under the given metric.

An entry can also interface external analytics packages.
`exometer_folsom`, for example, integrates with the
`folsom_metrics` package found at [`https://github.com/boundary/folsom`](https://github.com/boundary/folsom).


#### <a name="Probe">Probe</a> ####

Expand Down Expand Up @@ -291,20 +286,6 @@ values reported during the last minute.
The grand total of all values received during the lifetime of the
probe is also available.

The available data points under a metric using the spiral entry
are `count` (grand total) and `one` (sum for the last time span).


#### <a name="exometer_folsom_[entry]">exometer_folsom [entry]</a> ####

The folsom entry integrates with the folsom metrics package provided
by the boundary repo at github. Updated values sent to the folsom entry
can be forwarded to folsom's counter, histogram, duration, meter,
and spiral.

Folsom integration is provided as a backup. New code using Exometer Core
should use the native probes that duplicate folsom.


#### <a name="exometer_function_[entry]">exometer_function [entry]</a> ####

Expand Down Expand Up @@ -353,10 +334,6 @@ Note that dependent applications need to be started first. On newer OTP versions

For testing, you can also use [`exometer:start/0`](exometer.md#start-0).

If you make use of e.g. folsom metrics, you also need to start `folsom`.
Exometer Core will not do that automatically, nor does it contain an
application dependency for it.

See [Configuring Exometer Core](#Configuring_Exometer_Core) for details on configuration data
format.

Expand Down Expand Up @@ -524,10 +501,7 @@ Below is an example, from `exometer_core/priv/app.config`:
{['_'], function , [{module, exometer_function}]},
{['_'], counter , [{module, exometer}]},
{['_'], histogram, [{module, exometer_histogram}]},
{['_'], spiral , [{module, exometer_spiral}]},
{['_'], duration , [{module, exometer_folsom}]},
{['_'], meter , [{module, exometer_folsom}]},
{['_'], gauge , [{module, exometer_folsom}]}
{['_'], spiral , [{module, exometer_spiral}]}
]}
]}
```
Expand All @@ -542,9 +516,6 @@ exometer.template.function.module = exometer_function
exometer.template.counter.module = exometer
exometer.template.histogram.module = exometer_histogram
exometer.template.spiral.module = exometer_spiral
exometer.template.duration.module = exometer_folsom
exometer.template.meter.module = exometer_folsom
exometer.template.gauge.module = exometer_folsom
```


Expand Down Expand Up @@ -731,19 +702,15 @@ processing is complete.


<table width="100%" border="0" summary="list of modules">
<tr><td><a href="exo_montest.md" class="module">exo_montest</a></td></tr>
<tr><td><a href="exometer.md" class="module">exometer</a></td></tr>
<tr><td><a href="exometer_admin.md" class="module">exometer_admin</a></td></tr>
<tr><td><a href="exometer_alias.md" class="module">exometer_alias</a></td></tr>
<tr><td><a href="exometer_cache.md" class="module">exometer_cache</a></td></tr>
<tr><td><a href="exometer_cpu.md" class="module">exometer_cpu</a></td></tr>
<tr><td><a href="exometer_duration.md" class="module">exometer_duration</a></td></tr>
<tr><td><a href="exometer_entry.md" class="module">exometer_entry</a></td></tr>
<tr><td><a href="exometer_folsom.md" class="module">exometer_folsom</a></td></tr>
<tr><td><a href="exometer_folsom_monitor.md" class="module">exometer_folsom_monitor</a></td></tr>
<tr><td><a href="exometer_function.md" class="module">exometer_function</a></td></tr>
<tr><td><a href="exometer_histogram.md" class="module">exometer_histogram</a></td></tr>
<tr><td><a href="exometer_igor.md" class="module">exometer_igor</a></td></tr>
<tr><td><a href="exometer_info.md" class="module">exometer_info</a></td></tr>
<tr><td><a href="exometer_probe.md" class="module">exometer_probe</a></td></tr>
<tr><td><a href="exometer_proc.md" class="module">exometer_proc</a></td></tr>
Expand Down
7 changes: 3 additions & 4 deletions doc/edoc-info
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
%% encoding: UTF-8
{application,exometer_core}.
{modules,[exo_montest,exometer,exometer_admin,exometer_alias,exometer_cache,
exometer_cpu,exometer_duration,exometer_entry,exometer_folsom,
exometer_folsom_monitor,exometer_function,exometer_histogram,
exometer_igor,exometer_info,exometer_probe,exometer_proc,
{modules,[exometer,exometer_admin,exometer_alias,exometer_cache,exometer_cpu,
exometer_duration,exometer_entry,exometer_function,
exometer_histogram,exometer_info,exometer_probe,exometer_proc,
exometer_report,exometer_report_logger,exometer_report_tty,
exometer_shallowtree,exometer_slide,exometer_slot_slide,
exometer_spiral,exometer_uniform,exometer_util]}.
86 changes: 0 additions & 86 deletions doc/exo_montest.md

This file was deleted.

Loading

0 comments on commit 2582977

Please sign in to comment.