Packages

telemetry_poller

1.0.0
1.3.0 1.2.0 1.1.0 1.0.0 0.5.1 0.5.0 0.4.1 0.4.0 0.3.0 0.2.0 0.1.0

Periodically collect measurements and dispatch them as Telemetry events.

HexDocs

Current section

11 Versions

Jump to
Readme
11 Versions
1 Dependency
124 Dependants
Files
Activity
Hide whitespace

Compare versions

10 files changed
+170 additions
-48 deletions
  @@ -0,0 +1,114 @@
1 + # Changelog
2 +
3 + All notable changes to this project will be documented in this file.
4 +
5 + The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
6 + and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7 +
8 + ## [1.0.0](https://github.com/beam-telemetry/telemetry_poller/tree/v1.0.0)
9 +
10 + This release marks stability of the API. The library now requires Telemetry ~> 1.0.
11 +
12 + ### Fixed
13 +
14 + - Fix disabling the default poller via application environment.
15 +
16 + ### Changed
17 +
18 + - Drop support for OTP 20.
19 +
20 + ## [0.5.1](https://github.com/beam-telemetry/telemetry_poller/tree/v0.5.1)
21 +
22 + ### Added
23 +
24 + - Support `{:global, atom()}` and `{:via, module(), term()}` names for the poller process.
25 +
26 + ## [0.5.0](https://github.com/beam-telemetry/telemetry_poller/tree/v0.5.0)
27 +
28 + ### Added
29 +
30 + - `system_counts` measurement
31 +
32 + ## [0.4.1](https://github.com/beam-telemetry/telemetry_poller/tree/v0.4.1)
33 +
34 + ### Changed
35 +
36 + - Improve docs
37 + - No longer add a default name to telemetry processes
38 +
39 + ## [0.4.0](https://github.com/beam-telemetry/telemetry_poller/tree/v0.4.0)
40 +
41 + Telemetry Poller has been rewritten in Erlang so it can be used by the overall Erlang community.
42 + Therefore, the `Telemetry.Poller` module must now be accessed as `telemetry_poller`.
43 + A new `process_info` measurement has also been added and the `vm_measurements` and `measurements`
44 + keys have been merged into a single `measurements` key for simplicity.
45 +
46 + ### Added
47 +
48 + - `:process_info` measurement
49 +
50 + ### Changed
51 +
52 + - `vm_measurements` and `measurements` have been merged into `measurements`
53 + - `Telemetry.Poller` has been rewritten to `telemetry_poller`
54 +
55 + ## [0.3.0](https://github.com/beam-telemetry/telemetry_poller/tree/v0.3.0)
56 +
57 + This release marks the upgrade to Telemetry 0.4.0. This means that Poller measurements can emit a map
58 + of values now instead of a single one, making it less "noisy" when it comes to number of emitted events.
59 +
60 + All specific memory measurements have been replaced with a single `:memory` measurement sending all
61 + the values that were emitted by old measurements at once.
62 +
63 + `:run_queue_lengths` VM measurement has been removed for now, as we believe that as detailed data
64 + as it provided is not necessary to effectively debug the system. `:total_run_queue_lengths` VM
65 + measurement has been changed so that it reports a `:total` length of run queues, length of `:cpu`
66 + run queues (including dirty CPU run queue), and length of (dirty) `:io` run queue.
67 +
68 + ### Added
69 +
70 + - `:memory` VM measurement reporting all the data returned by `:erlang.memory/0` call.
71 +
72 + ### Changed
73 +
74 + - `:total_run_queue_lengths` VM measurement is reporting a `:total`, `:cpu` and `:io` run queue lengths
75 + now. See documentation for more details.
76 +
77 + ### Removed
78 +
79 + - `:total_memory`, `:atom_memory`, `:atom_used_memory`, `:processes_memory`, `:processes_used_memory`,
80 + `:binary_memory`, `:ets_memory`, `:code_memory` and `:system_memory` VM measurements have been removed.
81 + Please use the `:memory` measurement now instead.
82 +
83 + ## [0.2.0](https://github.com/beam-telemetry/telemetry_poller/tree/v0.2.0)
84 +
85 + ### Added
86 +
87 + - Added `:total_run_queue_lengths` and `:run_queue_lengths` memory measurements;
88 +
89 + ### Changed
90 +
91 + - `:total_run_queue_lengths` is now included in the set of default VM measurements;
92 + - A default Poller process, with a default set of VM measurements, is started when `:telemetry_poller`
93 + application starts (configurable via `:telemetry.poller, :default` application environment).
94 + - VM measurements are now provided to Poller's `:vm_measurements` option. Passing atom `:default`
95 + to this option makes the Poller use a default set of VM measurements;
96 + - Telemetry has been upgraded to version 0.3, meaning that VM measurements now use this version to
97 + emit the events.
98 +
99 + ### Removed
100 +
101 + - `Telemetry.Poller.vm_measurements/0` function has been removed in favor of `:vm_measurements`
102 + option.
103 +
104 + ### Fixed
105 +
106 + - Fixed the type definition of `Telemetry.Poller.measurement/0` type - no Dialyzer warnings are
107 + emitted when running it on the project.
108 +
109 + ## [0.1.0](https://github.com/beam-telemetry/telemetry_poller/tree/v0.1.0)
110 +
111 + ### Added
112 +
113 + - The Poller process periodically invoking registered functions which emit Telemetry events.
114 + It supports VM memory measurements and custom measurements provided as MFAs.
  @@ -1,6 +1,5 @@
1 1 # telemetry_poller
2 2
3 - [![CircleCI](https://circleci.com/gh/beam-telemetry/telemetry_poller.svg?style=svg)](https://circleci.com/gh/beam-telemetry/telemetry_poller)
4 3 [![Codecov](https://codecov.io/gh/beam-telemetry/telemetry_poller/branch/master/graphs/badge.svg)](https://codecov.io/gh/beam-telemetry/telemetry_poller/branch/master/graphs/badge.svg)
5 4
6 5 Allows to periodically collect measurements and dispatch them as Telemetry events.
  @@ -3,17 +3,17 @@
3 3 {<<"description">>,
4 4 <<"Periodically collect measurements and dispatch them as Telemetry events.">>}.
5 5 {<<"files">>,
6 - [<<"LICENSE">>,<<"NOTICE">>,<<"README.md">>,<<"rebar.config">>,
7 - <<"rebar.lock">>,<<"src/telemetry_poller.app.src">>,
6 + [<<"CHANGELOG.md">>,<<"LICENSE">>,<<"NOTICE">>,<<"README.md">>,
7 + <<"rebar.config">>,<<"rebar.lock">>,<<"src/telemetry_poller.app.src">>,
8 8 <<"src/telemetry_poller.erl">>,<<"src/telemetry_poller_app.erl">>,
9 9 <<"src/telemetry_poller_builtin.erl">>,<<"src/telemetry_poller_sup.erl">>]}.
10 10 {<<"licenses">>,[<<"Apache 2.0">>]}.
11 11 {<<"links">>,
12 - [{<<"Github">>,<<"https://github.com/beam-telemetry/telemetry_poller">>}]}.
12 + [{<<"GitHub">>,<<"https://github.com/beam-telemetry/telemetry_poller">>}]}.
13 13 {<<"name">>,<<"telemetry_poller">>}.
14 14 {<<"requirements">>,
15 15 [{<<"telemetry">>,
16 16 [{<<"app">>,<<"telemetry">>},
17 17 {<<"optional">>,false},
18 - {<<"requirement">>,<<"~> 0.4">>}]}]}.
19 - {<<"version">>,<<"0.5.1">>}.
18 + {<<"requirement">>,<<"~> 1.0">>}]}]}.
19 + {<<"version">>,<<"1.0.0">>}.
  @@ -1,21 +1,20 @@
1 1 {erl_opts, [{platform_define, "^19", 'OTP19'}, debug_info]}.
2 2 {deps, [
3 - {telemetry, "~> 0.4"}
3 + {telemetry, "~> 1.0"}
4 4 ]}.
5 5
6 6 {profiles, [
7 - {test, [{erl_opts, [nowarn_export_all]},
7 + {test, [
8 + {erl_opts, [nowarn_export_all]},
8 9 %% create junit xml for circleci
9 10 {ct_opts, [{ct_hooks, [cth_surefire]}]},
10 - {cover_enabled, true},
11 - {cover_opts, [verbose]},
12 - {paths, ["src", "test/support"]},
13 - %% convert to data codecov understands
14 - {plugins, [covertool]},
15 - {covertool, [{coverdata_files, ["ct.coverdata"]}]}
11 + {src_dirs, ["src", "test/support"]}
16 12 ]},
17 13 {docs, [{edoc_opts, [{preprocess, true},
18 - {title, "Telemetry Poller v0.5.1"}]}
14 + {doclet, edoc_doclet_chunks},
15 + {layout, edoc_layout_chunks},
16 + {dir, "_build/docs/lib/telemetry_poller/doc"}]}
17 +
19 18 ]}
20 19 ]}.
  @@ -1,6 +1,8 @@
1 - {"1.1.0",
2 - [{<<"telemetry">>,{pkg,<<"telemetry">>,<<"0.4.0">>},0}]}.
1 + {"1.2.0",
2 + [{<<"telemetry">>,{pkg,<<"telemetry">>,<<"1.0.0">>},0}]}.
3 3 [
4 4 {pkg_hash,[
5 - {<<"telemetry">>, <<"8339BEE3FA8B91CB84D14C2935F8ECF399CCD87301AD6DA6B71C09553834B2AB">>}]}
5 + {<<"telemetry">>, <<"0F453A102CDF13D506B7C0AB158324C337C41F1CC7548F0BC0E130BBF0AE9452">>}]},
6 + {pkg_hash_ext,[
7 + {<<"telemetry">>, <<"73BC09FA59B4A0284EFB4624335583C528E07EC9AE76ACA96EA0673850AEC57A">>}]}
6 8 ].
Loading more files…