diff --git a/CHANGELOG.md b/CHANGELOG.md index 5d917ea8..13c67cb3 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -76,7 +76,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - All plugin distribution buckets have been redefined. The reason for this being that prior to PromEx 1.7, some of the distribution buckets were a bit wasteful and were not adding value in terms of metrics data points. With this change, users should notice a decline in data point cardinality without compromising resolution. -- Application plugin has changed how it fetches dependency information. It is now using `Applciation.spec/1` to get the +- Application plugin has changed how it fetches dependency information. It is now using `Application.spec/1` to get the list of applications that are started with your application. This should reduce noise in the Grafana dashboard as all the default OTP and Elixir applications will not show up. - All Grafana dashboard now have a default panel sort order where the largest timeseries plot is first in the list when diff --git a/benchmarks/README.md b/benchmarks/README.md index fb2f59e9..7db269af 100644 --- a/benchmarks/README.md +++ b/benchmarks/README.md @@ -27,7 +27,7 @@ Usage: $0 OPTIONS OPTIONS: -c Concurrent connections (default: 1) --k Enable keepalive (defalt: no) +-k Enable keepalive (default: no) -E Extra parameters -n Number of requests (default: 1) -u Url to test (mandatory) @@ -49,8 +49,8 @@ Will create the following results: #### Test results -* [values.csv](exmple_results/values.csv) -* [percentages.csv](exmple_results/values.csv) +* [values.csv](example_results/values.csv) +* [percentages.csv](example_results/values.csv) #### Test summary results * summary.txt @@ -143,7 +143,7 @@ Usage: ./ab-graph_scale.sh OPTIONS OPTIONS: -c Start concurrent connections at (default: 5) --e Stop concurrent connections at (defalt: 25) +-e Stop concurrent connections at (default: 25) -k Enable keepalive connections (default: no) -s Concurrent connections increment step (default: 5) -n Number of requests (default: 500) diff --git a/benchmarks/ab-graph.sh b/benchmarks/ab-graph.sh index 99d41fa5..da929e49 100755 --- a/benchmarks/ab-graph.sh +++ b/benchmarks/ab-graph.sh @@ -23,7 +23,7 @@ Usage: $0 OPTIONS OPTIONS: -c Concurrent connections (default: 1) --k Enable keepalive (defalt: no) +-k Enable keepalive (default: no) -E Extra parameters -n Number of requests (default: 1) -u Url to test (mandatory) @@ -93,7 +93,7 @@ echo -e "${0} - version ${VERSION}\n" if [ "${CONCURRENCY}" == "" ]; then - echo "No concurrency set, using default value of ${DEFAULT_CONCURRENCY} simultanious clients" + echo "No concurrency set, using default value of ${DEFAULT_CONCURRENCY} simultaneous clients" CONCURRENCY=${DEFAULT_CONCURRENCY} fi diff --git a/benchmarks/ab-graph_scale.sh b/benchmarks/ab-graph_scale.sh index 82ab7e7b..126ca827 100755 --- a/benchmarks/ab-graph_scale.sh +++ b/benchmarks/ab-graph_scale.sh @@ -9,13 +9,13 @@ SLEEP=60 usage() { cat << EOF -Helper script for ab-graph that can run multple configurable runs in one go. +Helper script for ab-graph that can run multiple configurable runs in one go. Usage: $0 OPTIONS OPTIONS: -c Start concurrent connections at (default: 5) --e Stop concurrent connections at (defalt: 25) +-e Stop concurrent connections at (default: 25) -k Enable keepalive connections (default: no) -s Concurrent connections increment step (default: 5) -n Number of requests (default: 500) @@ -24,7 +24,7 @@ OPTIONS: -h Print help. -V Debug mode. -This script will do multple test runs of ab-graph incrementing the concurrent +This script will do multiple test runs of ab-graph incrementing the concurrent connections until the limit set by -e option is reached. EOF diff --git a/example_applications/shared_docker/grafana/datasources/datasource.yml b/example_applications/shared_docker/grafana/datasources/datasource.yml index b497657a..0fdd444e 100644 --- a/example_applications/shared_docker/grafana/datasources/datasource.yml +++ b/example_applications/shared_docker/grafana/datasources/datasource.yml @@ -7,7 +7,7 @@ deleteDatasources: orgId: 1 # list of datasources to insert/update depending -# whats available in the database +# what's available in the database datasources: # name of the datasource. Required - name: prometheus diff --git a/example_applications/web_app/lib/web_app/prom_ex.ex b/example_applications/web_app/lib/web_app/prom_ex.ex index a5be726a..53449d7f 100644 --- a/example_applications/web_app/lib/web_app/prom_ex.ex +++ b/example_applications/web_app/lib/web_app/prom_ex.ex @@ -15,7 +15,7 @@ defmodule WebApp.PromEx do 2. Add this module to your application supervision tree. It should be one of the first things that is started so that no Telemetry events are missed. For example, if PromEx - is started after your Repo module, you will miss Ecto's init events and the dashbaords + is started after your Repo module, you will miss Ecto's init events and the dashboards will be missing some data points: ``` def start(_type, _args) do diff --git a/lib/prom_ex/grafana_client.ex b/lib/prom_ex/grafana_client.ex index a10a191a..1ad97218 100644 --- a/lib/prom_ex/grafana_client.ex +++ b/lib/prom_ex/grafana_client.ex @@ -216,7 +216,7 @@ defmodule PromEx.GrafanaClient do unknown_response -> Logger.warning("Received an unhandled response from Grafana because: #{inspect(unknown_response)}") - {:error, :unkown} + {:error, :unknown} end end diff --git a/priv/beam.json.eex b/priv/beam.json.eex index 8558fbdc..1a0eb145 100644 --- a/priv/beam.json.eex +++ b/priv/beam.json.eex @@ -1543,7 +1543,7 @@ "dashLength": 10, "dashes": false, "datasource": "<%= @datasource_id %>", - "description": "The number of context switches that have occured along with the number of reductions.", + "description": "The number of context switches that have occurred along with the number of reductions.", "fieldConfig": { "defaults": { "custom": {}, diff --git a/priv/oban.json.eex b/priv/oban.json.eex index be26570f..8ad928b7 100644 --- a/priv/oban.json.eex +++ b/priv/oban.json.eex @@ -2559,7 +2559,7 @@ "dashLength": 10, "dashes": false, "datasource": "<%= @datasource_id %>", - "description": "The number of circuit breaker trip events that occured along with what component tripped the breaker.", + "description": "The number of circuit breaker trip events that occurred along with what component tripped the breaker.", "fieldConfig": { "defaults": { "custom": {} @@ -2652,7 +2652,7 @@ "dashLength": 10, "dashes": false, "datasource": "<%= @datasource_id %>", - "description": "The number of circuit breaker open events that occured along with what component tripped the breaker.", + "description": "The number of circuit breaker open events that occurred along with what component tripped the breaker.", "fieldConfig": { "defaults": { "custom": {} diff --git a/test/prom_ex/lifecycle_annotator_test.exs b/test/prom_ex/lifecycle_annotator_test.exs index 994ac41e..ed696d00 100644 --- a/test/prom_ex/lifecycle_annotator_test.exs +++ b/test/prom_ex/lifecycle_annotator_test.exs @@ -75,7 +75,7 @@ defmodule PromEx.LifecycleAnnotatorTest do # Ensure we get through the continue :sys.get_state(pid) - # Ensure we get another post for ther terminate callback + # Ensure we get another post for the terminate callback Bypass.expect(bypass, "POST", "/api/annotations", fn conn -> Plug.Conn.resp(conn, 200, response_payload) end) diff --git a/test/prom_ex/plugins/application_test.exs b/test/prom_ex/plugins/application_test.exs index 04529fff..bcad619f 100644 --- a/test/prom_ex/plugins/application_test.exs +++ b/test/prom_ex/plugins/application_test.exs @@ -20,7 +20,7 @@ defmodule PromEx.Plugins.ApplicationTest do start_supervised!(WebApp.PromEx) Events.execute_all(:application) - Metrics.assert_prom_ex_metics(WebApp.PromEx, :application) + Metrics.assert_prom_ex_metrics(WebApp.PromEx, :application) end describe "event_metrics/1" do diff --git a/test/prom_ex/plugins/beam_test.exs b/test/prom_ex/plugins/beam_test.exs index b3305f47..ba85d7b9 100644 --- a/test/prom_ex/plugins/beam_test.exs +++ b/test/prom_ex/plugins/beam_test.exs @@ -17,7 +17,7 @@ defmodule PromEx.Plugins.BeamTest do start_supervised!(WebApp.PromEx) Events.execute_all(:beam) - Metrics.assert_prom_ex_metics(WebApp.PromEx, :beam) + Metrics.assert_prom_ex_metrics(WebApp.PromEx, :beam) end describe "event_metrics/1" do diff --git a/test/prom_ex/plugins/broadway_test.exs b/test/prom_ex/plugins/broadway_test.exs index 3a2cad12..9c959d8a 100644 --- a/test/prom_ex/plugins/broadway_test.exs +++ b/test/prom_ex/plugins/broadway_test.exs @@ -25,7 +25,7 @@ defmodule PromEx.Plugins.BroadwayTest do start_supervised!(WebApp.PromEx) Events.execute_all(:broadway) - Metrics.assert_prom_ex_metics(WebApp.PromEx, :broadway) + Metrics.assert_prom_ex_metrics(WebApp.PromEx, :broadway) end describe "event_metrics/1" do diff --git a/test/prom_ex/plugins/ecto_test.exs b/test/prom_ex/plugins/ecto_test.exs index 48becb28..1d87711b 100644 --- a/test/prom_ex/plugins/ecto_test.exs +++ b/test/prom_ex/plugins/ecto_test.exs @@ -19,6 +19,6 @@ defmodule PromEx.Plugins.EctoTest do start_supervised!(WebApp.PromEx) Events.execute_all(:ecto) - Metrics.assert_prom_ex_metics(WebApp.PromEx, :ecto) + Metrics.assert_prom_ex_metrics(WebApp.PromEx, :ecto) end end diff --git a/test/prom_ex/plugins/oban_test.exs b/test/prom_ex/plugins/oban_test.exs index 05dd9afd..a383e9eb 100644 --- a/test/prom_ex/plugins/oban_test.exs +++ b/test/prom_ex/plugins/oban_test.exs @@ -20,7 +20,7 @@ defmodule PromEx.Plugins.ObanTest do Events.execute_all(:oban) - Metrics.assert_prom_ex_metics(WebApp.PromEx, :oban) + Metrics.assert_prom_ex_metrics(WebApp.PromEx, :oban) end describe "event_metrics/1" do diff --git a/test/prom_ex/plugins/phoenix_live_view_test.exs b/test/prom_ex/plugins/phoenix_live_view_test.exs index 56c0e9bb..f10fbc03 100644 --- a/test/prom_ex/plugins/phoenix_live_view_test.exs +++ b/test/prom_ex/plugins/phoenix_live_view_test.exs @@ -17,7 +17,7 @@ defmodule PromEx.Plugins.PhoenixLiveViewTest do start_supervised!(WebApp.PromEx) Events.execute_all(:phoenix_live_view) - Metrics.assert_prom_ex_metics(WebApp.PromEx, :phoenix_live_view) + Metrics.assert_prom_ex_metrics(WebApp.PromEx, :phoenix_live_view) end describe "event_metrics/1" do diff --git a/test/prom_ex/plugins/phoenix_multi_router_test.exs b/test/prom_ex/plugins/phoenix_multi_router_test.exs index 31a0d1dd..0778d420 100644 --- a/test/prom_ex/plugins/phoenix_multi_router_test.exs +++ b/test/prom_ex/plugins/phoenix_multi_router_test.exs @@ -33,6 +33,6 @@ defmodule PromEx.Plugins.PhoenixMultiRouterTest do start_supervised!(WebApp.PromEx) Events.execute_all(:phoenix_multi_router) - Metrics.assert_prom_ex_metics(WebApp.PromEx, :phoenix_multi_router) + Metrics.assert_prom_ex_metrics(WebApp.PromEx, :phoenix_multi_router) end end diff --git a/test/prom_ex/plugins/phoenix_test.exs b/test/prom_ex/plugins/phoenix_test.exs index c4b0c842..123bdfb3 100644 --- a/test/prom_ex/plugins/phoenix_test.exs +++ b/test/prom_ex/plugins/phoenix_test.exs @@ -63,14 +63,14 @@ defmodule PromEx.Plugins.PhoenixTest do start_supervised!(WebApp.PromExSingleEndpoint) Events.execute_all(:phoenix) - Metrics.assert_prom_ex_metics(WebApp.PromExSingleEndpoint, :phoenix) + Metrics.assert_prom_ex_metrics(WebApp.PromExSingleEndpoint, :phoenix) end test "telemetry events are accumulated for multiple endpoint configuration" do start_supervised!(WebApp.PromExMultipleEndpoint) Events.execute_all(:phoenix) - Metrics.assert_prom_ex_metics(WebApp.PromExMultipleEndpoint, :phoenix) + Metrics.assert_prom_ex_metrics(WebApp.PromExMultipleEndpoint, :phoenix) end test "channel events normalize according to normalize_event_name" do diff --git a/test/prom_ex/plugins/plug_cowboy_test.exs b/test/prom_ex/plugins/plug_cowboy_test.exs index 450c13cc..73428113 100644 --- a/test/prom_ex/plugins/plug_cowboy_test.exs +++ b/test/prom_ex/plugins/plug_cowboy_test.exs @@ -19,7 +19,7 @@ defmodule PromEx.Plugins.PlugCowboyTest do start_supervised!(WebApp.PromEx) Events.execute_all(:plug_cowboy) - Metrics.assert_prom_ex_metics(WebApp.PromEx, :plug_cowboy) + Metrics.assert_prom_ex_metrics(WebApp.PromEx, :plug_cowboy) end describe "event_metrics/1" do diff --git a/test/prom_ex/plugins/plug_router_test.exs b/test/prom_ex/plugins/plug_router_test.exs index 9321c57d..daa4ce4f 100644 --- a/test/prom_ex/plugins/plug_router_test.exs +++ b/test/prom_ex/plugins/plug_router_test.exs @@ -25,7 +25,7 @@ defmodule PromEx.Plugins.PlugRouterTest do start_supervised!(TestApp.PromEx) Events.execute_all(:plug_router) - Metrics.assert_prom_ex_metics(TestApp.PromEx, :plug_router) + Metrics.assert_prom_ex_metrics(TestApp.PromEx, :plug_router) end describe "event_metrics/1" do diff --git a/test/prom_ex_test.exs b/test/prom_ex_test.exs index ee818265..21ba6191 100644 --- a/test/prom_ex_test.exs +++ b/test/prom_ex_test.exs @@ -102,7 +102,7 @@ defmodule PromExTest do # Give the manual metrics manager a chance to capture application metrics Process.sleep(1_000) - # Get supervsion tree child proceses + # Get supervsion tree child processes manual_metrics_pid = Process.whereis(DefaultPromExSetUp.__manual_metrics_name__()) metrics_collector_pid = Process.whereis(DefaultPromExSetUp.__metrics_collector_name__()) dashboard_uploader_pid = Process.whereis(DefaultPromExSetUp.__dashboard_uploader_name__()) diff --git a/test/support/metrics.ex b/test/support/metrics.ex index 513548c6..8e736cbf 100644 --- a/test/support/metrics.ex +++ b/test/support/metrics.ex @@ -29,8 +29,8 @@ defmodule PromEx.Test.Support.Metrics do end @doc false - @spec assert_prom_ex_metics(module(), atom()) :: :ok - def assert_prom_ex_metics(prom_ex_module, expected_metrics_lookup) do + @spec assert_prom_ex_metrics(module(), atom()) :: :ok + def assert_prom_ex_metrics(prom_ex_module, expected_metrics_lookup) do collected_metrics = read_collected(prom_ex_module) expected_metrics = read_expected(expected_metrics_lookup)