resource

Documentation

Overview

*Copyright (c) 2022, kaydxh * *Permission is hereby granted, free of charge, to any person obtaining a copy *of this software and associated documentation files (the "Software"), to deal *in the Software without restriction, including without limitation the rights *to use, copy, modify, merge, publish, distribute, sublicense, and/or sell *copies of the Software, and to permit persons to whom the Software is *furnished to do so, subject to the following conditions: * *The above copyright notice and this permission notice shall be included in all *copies or substantial portions of the Software. * *THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR *IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, *FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE *AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER *LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, *OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE *SOFTWARE.

*Copyright (c) 2024, kaydxh * *Permission is hereby granted, free of charge, to any person obtaining a copy *of this software and associated documentation files (the "Software"), to deal *in the Software without restriction, including without limitation the rights *to use, copy, modify, merge, publish, distribute, sublicense, and/or sell *copies of the Software, and to permit persons to whom the Software is *furnished to do so, subject to the following conditions: * *The above copyright notice and this permission notice shall be included in all *copies or substantial portions of the Software. * *THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR *IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, *FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE *AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER *LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, *OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE *SOFTWARE.

Index

• Constants
• func Attrs() []attribute.KeyValue
• type EmptyResourceStatsServiceOption
• type ResourceStatsMetrics
  • func NewResourceStatsMetrics() (*ResourceStatsMetrics, error)
  • func (r *ResourceStatsMetrics) ReportMetric(ctx context.Context) (total, avaiable, usage float64)
• type ResourceStatsOptions
• type ResourceStatsService
  • func NewResourceStatsService(opts ...ResourceStatsServiceOption) (*ResourceStatsService, error)
  • func (o *ResourceStatsService) ApplyOptions(options ...ResourceStatsServiceOption) *ResourceStatsService
  • func (s *ResourceStatsService) Run(ctx context.Context) error
  • func (s *ResourceStatsService) Serve(ctx context.Context) error
  • func (s *ResourceStatsService) Shutdown()
• type ResourceStatsServiceOption
  • func WithMemoryCallBack(f func(total uint64, free uint64, usage float64)) ResourceStatsServiceOption
  • func WithStatsCheckInterval(interval time.Duration) ResourceStatsServiceOption
• type ResourceStatsServiceOptionFunc

Constants

const (
	MemoryTotalKey     = "memory_total"
	MemoryUsageKey     = "memory_usage"
	MemoryAvaliableKey = "memory_avaliable"
)

const (
	DefaultCheckInterval time.Duration = time.Minute
)

Functions

func Attrs

func Attrs() []attribute.KeyValue

Types

type EmptyResourceStatsServiceOption

type EmptyResourceStatsServiceOption struct{}

EmptyResourceStatsServiceOption does not alter the configuration. It can be embedded in another structure to build custom options.

This API is EXPERIMENTAL.

type ResourceStatsMetrics

type ResourceStatsMetrics struct {
	MemoryTotalHistogram     syncfloat64.Histogram
	MemoryUsageHistogram     syncfloat64.Histogram
	MemoryAvaliableHistogram syncfloat64.Histogram
}

func NewResourceStatsMetrics

func NewResourceStatsMetrics() (*ResourceStatsMetrics, error)

func (*ResourceStatsMetrics) ReportMetric

func (r *ResourceStatsMetrics) ReportMetric(ctx context.Context) (total, avaiable, usage float64)

type ResourceStatsOptions

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

type ResourceStatsService

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

func NewResourceStatsService

func NewResourceStatsService(opts ...ResourceStatsServiceOption) (*ResourceStatsService, error)

func (*ResourceStatsService) ApplyOptions

func (o *ResourceStatsService) ApplyOptions(options ...ResourceStatsServiceOption) *ResourceStatsService

func (*ResourceStatsService) Run

func (s *ResourceStatsService) Run(ctx context.Context) error

Run will initialize the backend. It must not block, but may run go routines in the background.

func (*ResourceStatsService) Serve

func (s *ResourceStatsService) Serve(ctx context.Context) error

Serve ...

func (*ResourceStatsService) Shutdown

func (s *ResourceStatsService) Shutdown()

Shutdown ...

type ResourceStatsServiceOption

type ResourceStatsServiceOption interface {
	// contains filtered or unexported methods
}

A ResourceStatsServiceOption sets options.

func WithMemoryCallBack

func WithMemoryCallBack(f func(total uint64, free uint64, usage float64)) ResourceStatsServiceOption

func WithStatsCheckInterval

func WithStatsCheckInterval(interval time.Duration) ResourceStatsServiceOption

type ResourceStatsServiceOptionFunc

type ResourceStatsServiceOptionFunc func(*ResourceStatsService)

ResourceStatsServiceOptionFunc wraps a function that modifies Client into an implementation of the ResourceStatsServiceOption interface.