grafana

Documentation

Overview

Copyright 2022 Nethermind

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Copyright 2022 Nethermind

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Copyright 2022 Nethermind

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Index

• Variables
• type GrafanaService
  • func NewGrafana() *GrafanaService
  • func (g *GrafanaService) AddTarget(target types.MonitoringTarget, labels map[string]string, jobName string) error
  • func (g *GrafanaService) ContainerName() string
  • func (g *GrafanaService) DotEnv() map[string]string
  • func (g *GrafanaService) Endpoint() string
  • func (g *GrafanaService) Init(opts types.ServiceOptions) error
  • func (g *GrafanaService) Name() string
  • func (g *GrafanaService) RemoveTarget(instanceId string) (string, error)
  • func (g *GrafanaService) SetContainerIP(ip net.IP)
  • func (g *GrafanaService) Setup(options map[string]string) error

Variables

var (
	ErrConfigNotFound = errors.New("configuration file not found")
	ErrInvalidOptions = errors.New("invalid options for grafana setup")
)

Types

type GrafanaService

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

GrafanaService implements the ServiceAPI interface for a Grafana service.

func NewGrafana

func NewGrafana() *GrafanaService

NewGrafana creates a new GrafanaService.

func (*GrafanaService) AddTarget

func (g *GrafanaService) AddTarget(target types.MonitoringTarget, labels map[string]string, jobName string) error

func (*GrafanaService) ContainerName

func (g *GrafanaService) ContainerName() string

func (*GrafanaService) DotEnv

func (g *GrafanaService) DotEnv() map[string]string

DotEnv returns the dotenv variables and default values for the Grafana service.

func (*GrafanaService) Endpoint

func (g *GrafanaService) Endpoint() string

func (*GrafanaService) Init

func (g *GrafanaService) Init(opts types.ServiceOptions) error

Init initializes the Grafana service with the given options.

func (*GrafanaService) Name

func (g *GrafanaService) Name() string

func (*GrafanaService) RemoveTarget

func (g *GrafanaService) RemoveTarget(instanceId string) (string, error)

func (*GrafanaService) SetContainerIP

func (g *GrafanaService) SetContainerIP(ip net.IP)

func (*GrafanaService) Setup

func (g *GrafanaService) Setup(options map[string]string) error

Setup sets up the Grafana service provisioning and configuration with the given dotenv values.