Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Misc doc changes #38

Merged
merged 1 commit into from
Jan 11, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

Elixir [Prometheus.io](https://prometheus.io) client based on [Prometheus.erl](https://github.com/deadtrickster/prometheus.erl).

Starting from v3.0.0 works with Elixir >=1.6 and Erlang >=20. For older verions, please use older tags.
Starting from v3.0.0 works with Elixir >=1.6 and Erlang >=20. For older versions, please use older tags.

![@skosch dashboard](https://aldusleaf.org/assets/images/2016/09/grafana.jpg)

Expand Down Expand Up @@ -63,7 +63,7 @@ Please read how to [measure durations correctly with prometheus.ex](https://hexd
- [Extatus - App to report metrics to Prometheus from Elixir GenServers](https://github.com/gmtprime/extatus)
- [Plugs Instrumenter/Exporter](https://github.com/deadtrickster/prometheus-plugs)
- [Fuse plugin](https://github.com/jlouis/fuse#fuse_stats_prometheus)
- [OS process info Collector](https://hex.pm/packages/prometheus_process_collector) (linux-only)
- [OS process info Collector](https://hex.pm/packages/prometheus_process_collector) (Linux-only)
- [Phoenix instrumenter](https://github.com/deadtrickster/prometheus-phoenix)
- [RabbitMQ Exporter](https://github.com/deadtrickster/prometheus_rabbitmq_exporter)

Expand Down
2 changes: 1 addition & 1 deletion lib/prometheus.ex
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ defmodule Prometheus do
- [Elixir plugs Instrumenters and Exporter](https://hex.pm/packages/prometheus_plugs);
- [Fuse plugin](https://github.com/jlouis/fuse#fuse_stats_prometheus)
- [OS process info Collector](https://hex.pm/packages/prometheus_process_collector)
(linux-only);
(Linux-only);
- [Phoenix Instrumenter](https://hex.pm/packages/prometheus_phoenix);
- [RabbitMQ Exporter](https://github.com/deadtrickster/prometheus_rabbitmq_exporter).

Expand Down
2 changes: 1 addition & 1 deletion lib/prometheus/metric.ex
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ defmodule Prometheus.Metric do
`@<type>` attributes. Metrics will be declared in
the `@on_load` callback. If the module already
has `@on_load` callback, metrics will be declared
iff the callback returns `:ok`.
if the callback returns `:ok`.

Example:

Expand Down
4 changes: 2 additions & 2 deletions lib/prometheus/metric/gauge.ex
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ defmodule Prometheus.Metric.Gauge do
running processes.

Example use cases for Gauges:
- Inprogress requests;
- In progress requests;
- Number of items in a queue;
- Free memory;
- Total memory;
Expand Down Expand Up @@ -116,7 +116,7 @@ defmodule Prometheus.Metric.Gauge do
delegate_metric dec(spec, value \\ 1)

@doc """
Sets the gauge identified by `spec` to the current unixtime.
Sets the gauge identified by `spec` to the current unix time.

Raises `Prometheus.UnknownMetricError` exception if a gauge
for `spec` can't be found.<br>
Expand Down
2 changes: 1 addition & 1 deletion lib/prometheus/metric/histogram.ex
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
defmodule Prometheus.Metric.Histogram do
@moduledoc """
A Histogram tracks the size and number of events in buckets.
You can use Histograms for aggregatable calculation of quantiles.
You can use Histograms for aggregating calculation of quantiles.

Example use cases for Histograms:
- Response latency;
Expand Down
5 changes: 3 additions & 2 deletions mix.exs
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
defmodule PrometheusEx.Mixfile do
use Mix.Project

@source_url "https://github.com/deadtrickster/prometheus.ex"
@version "3.0.5"

def project do
Expand All @@ -19,7 +20,7 @@ defmodule PrometheusEx.Mixfile do
docs: [
main: Prometheus,
source_ref: "v#{@version}",
source_url: "https://github.com/deadtrickster/prometheus.ex",
source_url: @source_url,
extras: [
"pages/Mnesia Collector.md",
"pages/VM Memory Collector.md",
Expand All @@ -46,7 +47,7 @@ defmodule PrometheusEx.Mixfile do
maintainers: ["Ilya Khaprov"],
licenses: ["MIT"],
links: %{
"GitHub" => "https://github.com/deadtrickster/prometheus.ex",
"GitHub" => @source_url,
"Prometheus.erl" => "https://hex.pm/packages/prometheus",
"Inets HTTPD Exporter" => "https://hex.pm/packages/prometheus_httpd",
"Ecto Instrumenter" => "https://hex.pm/packages/prometheus_ecto",
Expand Down