stdout

README

Stdout reporter

The stdout reporter prints a nice and concise summary of the application's health directly top stdout:

╭--------------------------------------╮
|Health Status                         |
|--------------------------------------|
|live:                              yes|
|ready:                              no|
|--------------------------------------|
|Checks                                |
|╭------------------------------------╮|
||name                      test_check||
||healthy                          yes||
||affects liveness                 yes||
||affects readiness                yes||
|╰------------------------------------╯|
╰--------------------------------------╯

This reporter is great for local development. It is not intended to be used for logging.

Documentation

Overview

Code generated by github.com/schigh/carto. DO NOT EDIT.

Index

• type Reporter
  • func (r *Reporter) Run(_ context.Context) error
  • func (r *Reporter) SetLiveness(_ context.Context, b bool)
  • func (r *Reporter) SetReadiness(_ context.Context, b bool)
  • func (r *Reporter) Stop(_ context.Context) error
  • func (r *Reporter) UpdateHealthChecks(_ context.Context, m map[string]*healthpb.Check)

Types

type Reporter

type Reporter struct {
	// contains filtered or unexported fields
}

Reporter reports.

func (*Reporter) Run

func (r *Reporter) Run(_ context.Context) error

func (*Reporter) SetLiveness

func (r *Reporter) SetLiveness(_ context.Context, b bool)

func (*Reporter) SetReadiness

func (r *Reporter) SetReadiness(_ context.Context, b bool)

func (*Reporter) Stop

func (r *Reporter) Stop(_ context.Context) error

func (*Reporter) UpdateHealthChecks

func (r *Reporter) UpdateHealthChecks(_ context.Context, m map[string]*healthpb.Check)