sre

package
v0.9.3 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: May 28, 2026 License: Apache-2.0 Imports: 8 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func CreateObservableDataContext 

func CreateObservableDataContext(metricsCollector *MetricsCollector, dataContext *managers.DataContext) managers.DataContext

CreateObservableDataContext function that wraps DataContext operations for observability

Types

type MetricsCollector 

type MetricsCollector struct {
	// Http requests (total both OK and non-OK)
	HttpRequestsTotalCount *prometheus.CounterVec
	// Http requests that were finished with server Error (4xx or 5xx)
	HttpRequestsErrorCount *prometheus.CounterVec
	HttpRequestDurations   prometheus.Summary
	// Request to dataSource (is not usable for File), cli not produces HttpRequestsCount
	DataSourceRequestsTotalCount *prometheus.CounterVec
	DataSourceRequestsErrorCount *prometheus.CounterVec
	DataSourceRequestDurations   prometheus.Summary
}

MetricsCollector is a struct that collects of metrics that is using for application observability

func CreateMetricsCollector 

func CreateMetricsCollector() *MetricsCollector

func (*MetricsCollector) HttpMetricsCollectMiddleware 

func (mc *MetricsCollector) HttpMetricsCollectMiddleware() gin.HandlerFunc

HttpMetricsCollectMiddleware function is using to track all HTTP-requests and collect

func (*MetricsCollector) UnRegisterAllMetrics 

func (mc *MetricsCollector) UnRegisterAllMetrics()

type ObservableDataContext 

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

ObservableDataContext struct that implements managers.DataContext

func (*ObservableDataContext) CreateClient 

func (mn *ObservableDataContext) CreateClient(realmName string, clientData data.Client) error

CreateClient creates new data.Client in a data store, requires to pass realmName (because client name is not unique), clientData is an unmarshalled json of type data.Client 

Function that wraps managers.DataContext CreateClient with getting the following metrics:
*   1. DataSource requests duration - DataSourceRequestDurations in us
*   2. DataSourceRequestsTotalCount - count of requests with key and status labels

func (*ObservableDataContext) CreateRealm 

func (mn *ObservableDataContext) CreateRealm(realmData data.Realm) error

CreateRealm creates new data.Realm in a data store, receive realmData unmarshalled json in a data.Realm 

Function that wraps managers.DataContext CreateRealm with getting the following metrics:
*   1. DataSource requests duration - DataSourceRequestDurations in us
*   2. DataSourceRequestsTotalCount - count of requests with key and status labels

func (*ObservableDataContext) CreateUser 

func (mn *ObservableDataContext) CreateUser(realmName string, userData data.User) error

CreateUser creates new data.User in a data store within a realm with name = realmName 

Function that wraps managers.DataContext CreateUser with getting the following metrics:
*   1. DataSource requests duration - DataSourceRequestDurations in us
*   2. DataSourceRequestsTotalCount - count of requests with key and status labels

func (*ObservableDataContext) CreateUserFederationConfig 

func (mn *ObservableDataContext) CreateUserFederationConfig(realmName string, userFederationConfig data.UserFederationServiceConfig) error

CreateUserFederationConfig function for creating data.UserFederationServiceConfig in data.Realm 

Function that wraps managers.DataContext CreateUserFederationConfig with getting the following metrics:
*   1. DataSource requests duration - DataSourceRequestDurations in us
*   2. DataSourceRequestsTotalCount - count of requests with key and status labels

func (*ObservableDataContext) DeleteClient 

func (mn *ObservableDataContext) DeleteClient(realmName string, clientName string) error

DeleteClient removes client with name = clientName from realm with name = clientName 

Function that wraps managers.DataContext DeleteClient with getting the following metrics:
*   1. DataSource requests duration - DataSourceRequestDurations in us
*   2. DataSourceRequestsTotalCount - count of requests with key and status labels

func (*ObservableDataContext) DeleteRealm 

func (mn *ObservableDataContext) DeleteRealm(realmName string) error

DeleteRealm removes realm from data storage (Should be a CASCADE remove of all related Users and Clients) 

Function that wraps managers.DataContext DeleteRealm with getting the following metrics:
*   1. DataSource requests duration - DataSourceRequestDurations in us
*   2. DataSourceRequestsTotalCount - count of requests with key and status labels

func (*ObservableDataContext) DeleteUser 

func (mn *ObservableDataContext) DeleteUser(realmName string, userName string) error

DeleteUser removes data.User from data store by user (userName) and realm (realmName) name respectively 

Function that wraps managers.DataContext DeleteUser with getting the following metrics:
*   1. DataSource requests duration - DataSourceRequestDurations in us
*   2. DataSourceRequestsTotalCount - count of requests with key and status labels

func (*ObservableDataContext) DeleteUserFederationConfig 

func (mn *ObservableDataContext) DeleteUserFederationConfig(realmName string, configName string) error

DeleteUserFederationConfig function for removing data.UserFederationServiceConfig from data store by realm (realmName) name respectively 

Function that wraps managers.DataContext DeleteUserFederationConfig with getting the following metrics:
*   1. DataSource requests duration - DataSourceRequestDurations in us
*   2. DataSourceRequestsTotalCount - count of requests with key and status labels

func (*ObservableDataContext) GetClient 

func (mn *ObservableDataContext) GetClient(realmName string, clientName string) (*data.Client, error)

GetClient function for getting Realm Client by name 

Function that wraps managers.DataContext GetClient with getting the following metrics:
*   1. DataSource requests duration - DataSourceRequestDurations in us
*   2. DataSourceRequestsTotalCount - count of requests with key and status labels

func (*ObservableDataContext) GetRealm 

func (mn *ObservableDataContext) GetRealm(realmName string) (*data.Realm, error)

GetRealm function for Observe (SRE) getting realm operation 

Function that wraps managers.DataContext GetRealm with getting the following metrics:
*   1. DataSource requests duration - DataSourceRequestDurations in us
*   2. DataSourceRequestsTotalCount - count of requests with key and status labels

func (*ObservableDataContext) GetServerSettings 

func (mn *ObservableDataContext) GetServerSettings() (*data.ServerSettings, error)

GetServerSettings function that returns ServerSettings 

Function that wraps managers.DataContext GetServerSettings with getting the following metrics:
*   1. DataSource requests duration - DataSourceRequestDurations in us
*   2. DataSourceRequestsTotalCount - count of requests with key and status labels

func (*ObservableDataContext) GetUser 

func (mn *ObservableDataContext) GetUser(realmName string, userName string) (data.User, error)

GetUser function for getting Realm User by userName 

Function that wraps managers.DataContext GetUser with getting the following metrics:
*   1. DataSource requests duration - DataSourceRequestDurations in us
*   2. DataSourceRequestsTotalCount - count of requests with key and status labels

func (*ObservableDataContext) GetUserById 

func (mn *ObservableDataContext) GetUserById(realmName string, userId uuid.UUID) (data.User, error)

GetUserById function for getting Realm User by UserId (uuid) 

Function that wraps managers.DataContext GetUserById with getting the following metrics:
*   1. DataSource requests duration - DataSourceRequestDurations in us
*   2. DataSourceRequestsTotalCount - count of requests with key and status labels

func (*ObservableDataContext) GetUserFederationConfig 

func (mn *ObservableDataContext) GetUserFederationConfig(realmName string, configName string) (*data.UserFederationServiceConfig, error)

GetUserFederationConfig function for getting data.UserFederationServiceConfig from data store by realm (realmName) name respectively 

Function that wraps managers.DataContext GetUserFederationConfig with getting the following metrics:
*   1. DataSource requests duration - DataSourceRequestDurations in us
*   2. DataSourceRequestsTotalCount - count of requests with key and status labels

func (*ObservableDataContext) IsAvailable 

func (mn *ObservableDataContext) IsAvailable() bool

IsAvailable this function we do not observe yet

func (*ObservableDataContext) SetServerSettings 

func (mn *ObservableDataContext) SetServerSettings(settings *data.ServerSettings) error

SetServerSettings function that updates ServerSettings by full new settings replace 

Function that wraps managers.DataContext SetServerSettings with getting the following metrics:
*   1. DataSource requests duration - DataSourceRequestDurations in us
*   2. DataSourceRequestsTotalCount - count of requests with key and status labels

func (*ObservableDataContext) UpdateClient 

func (mn *ObservableDataContext) UpdateClient(realmName string, clientName string, clientData data.Client) error

UpdateClient updates existing data.Client in a data store with name = clientName and new data = clientData 

Function that wraps managers.DataContext UpdateClient with getting the following metrics:
*   1. DataSource requests duration - DataSourceRequestDurations in us
*   2. DataSourceRequestsTotalCount - count of requests with key and status labels

func (*ObservableDataContext) UpdateRealm 

func (mn *ObservableDataContext) UpdateRealm(realmName string, realmData data.Realm) error

UpdateRealm updates existing data.Realm in a data store within name = realmData, and new data = realmData 

Function that wraps managers.DataContext UpdateRealm with getting the following metrics:
*   1. DataSource requests duration - DataSourceRequestDurations in us
*   2. DataSourceRequestsTotalCount - count of requests with key and status labels

func (*ObservableDataContext) UpdateUser 

func (mn *ObservableDataContext) UpdateUser(realmName string, userName string, userData data.User) error

UpdateUser updates existing data.User in a data store with realm name = realName, username = userName and data=userData 

Function that wraps managers.DataContext UpdateUser with getting the following metrics:
*   1. DataSource requests duration - DataSourceRequestDurations in us
*   2. DataSourceRequestsTotalCount - count of requests with key and status labels

func (*ObservableDataContext) UpdateUserFederationConfig 

func (mn *ObservableDataContext) UpdateUserFederationConfig(realmName string, configName string, userFederationConfig data.UserFederationServiceConfig) error

UpdateUserFederationConfig function for updating the data.UserFederationServiceConfig from data store by config (configName) and realm (realmName) name respectively 

Function that wraps managers.DataContext UpdateUserFederationConfig with getting the following metrics:
*   1. DataSource requests duration - DataSourceRequestDurations in us
*   2. DataSourceRequestsTotalCount - count of requests with key and status labels

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.