https://github.com/skbolton/vitals

https://github.com/skbolton/vitals

Last synced: 15 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/skbolton/vitals
• Owner: skbolton
• Created: 2023-09-29T20:13:25.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2023-10-07T22:30:36.000Z (about 1 year ago)
• Last Synced: 2024-10-11T19:46:46.438Z (about 1 month ago)
• Language: Elixir
• Size: 35.2 KB
• Stars: 0
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Vitals

## Plan

```elixir

# in application.ex or root supervisor

{

  Vitals.Supervisor,

  handlers: [

    Vitals.Handler.spec(

      id: "ecto"

      mod: EctoHandler,

    ),

    Vitals.Handler.spec(

      id: "ecto-readonly"

      mod: EctoHandler,

    ),

    Vitals.Handler.spec(

      id: "stripe",

      mod: StripeHandler,

    )

  ]

}

```

```elixir

# getting diagnostics in router

Vitals.check_diagnostics(:http) # :http | :exit_code | :io | :pretty

# getting diagnostics in iex

Vitals.check_diagnostics(:pretty) # :http | :exit_code | :io | :pretty

```

```yaml

# getting diagnostics in kubernetes command

spec:

  containers:

    livenessProbe:

      exec:

        command:

          - /app/bin/my-app

          - eval

          - "Vitals.check_diagnostics(:exit_code)"

```

```elixir

# writing a handler

defmodule MyApp.Vitals.Handler do

  @behaviour Vitals.Handler

  alias Vitals.Diagnostic

  @impl Vitals.Handler

  def check(las_diagnostic) do

    %Diagnostic{}

  end

  @impl Vitals.Handler

  def init(_opts) do

    %Diagnostic{timer: %{every: {5, :second}}}

  end

end

```

If [available in Hex](https://hex.pm/docs/publish), the package can be installed

by adding `vitals` to your list of dependencies in `mix.exs`:

```elixir

def deps do

  [

    {:vitals, "~> 0.1.0"}

  ]

end

```

Documentation can be generated with [ExDoc](https://github.com/elixir-lang/ex_doc)

and published on [HexDocs](https://hexdocs.pm). Once published, the docs can

be found at .