Class ProxyConnector

Description

Proxy connector with prometheus metrics

Features:

see @biorate/proxy features
prometheus metrics

Examples

see @biorate/proxy examples

Hierarchy

ProxyConnector
- ProxyConnector

Index

Constructors

Properties

#connections #current active config namespace read write

Accessors

connections current

Methods

connect connection create get getStatData initialize metrics stats use

Constructors

constructor

new ProxyConnector(): ProxyConnector
Returns ProxyConnector

Inherited from ProxyConnector.constructor

Properties

`Private` #connections

#connections: Map<string, ProxyConnection> = ...

Description

Private connections storage

`Private` #current

#current: ProxyConnection = undefined

Description

Private link to selected (used) connection

`Protected` active

active: Gauge

Description

activity status metric

`Protected` config

config: IConfig

Description

Config dependency

`Protected` `Readonly` namespace

namespace: "Proxy" = 'Proxy'

Description

Namespace path for fetching configuration

`Protected` read

read: Gauge

Description

read bytes metric

`Protected` write

write: Gauge

Description

write bytes metric

Accessors

connections

get connections(): Map<string, T>
Returns Map<string, T>

Description
Connections storage
Inherited from BaseProxyConnector.connections
- Defined in packages/@biorate/connector/src/index.ts:81

current

get current(): T
Returns T

Description
Link to selected (used) connection
Inherited from BaseProxyConnector.current
- Defined in packages/@biorate/connector/src/index.ts:87

Methods

`Protected` connect

connect(config): Promise<ProxyConnection>
Parameters
- config: IProxyConfig
Returns Promise<ProxyConnection>

Description
Create connection
Inherited from ProxyConnector.connect
- Defined in packages/@biorate/proxy/src/index.ts:119

connection

connection(name?): ProxyConnection
Parameters
- Optional name: string
  Optional
Returns ProxyConnection

Description
Method for get existed the connection
Inherited from ProxyConnector.connection
- Defined in packages/@biorate/connector/src/index.ts:113

create

create(config): Promise<ProxyConnection>
Parameters
- config: IProxyConfig
Returns Promise<ProxyConnection>

Description
Method for creating new connection
Inherited from ProxyConnector.create
- Defined in packages/@biorate/connector/src/index.ts:97

get

get(name?): ProxyConnection
Parameters
- Optional name: string
  Optional
Returns ProxyConnection

Description
Alias for connection method
Inherited from ProxyConnector.get
- Defined in packages/@biorate/connector/src/index.ts:124

`Protected` getStatData

getStatData(): {
    active: boolean;
    backendHost: string;
    connection: string;
    proxyHost: string;
    read: number;
    write: number;
}[]
Returns {
    active: boolean;
    backendHost: string;
    connection: string;
    proxyHost: string;
    read: number;
    write: number;
}[]

Description
Get stat data
Inherited from ProxyConnector.getStatData
- Defined in packages/@biorate/proxy/src/index.ts:157

`Protected` initialize

initialize(): Promise<void>
Returns Promise<void>

Description
initialize
Overrides ProxyConnector.initialize
- Defined in packages/@biorate/proxy-prometheus/src/index.ts:70

`Protected` metrics

metrics(): Promise<void>
Returns Promise<void>

Description
log metrics
- Defined in packages/@biorate/proxy-prometheus/src/index.ts:50

`Protected` stats

stats(): void
Returns void

Description
stats server enable
Inherited from ProxyConnector.stats
- Defined in packages/@biorate/proxy/src/index.ts:131

use

use(name): void
Parameters
- name: string
Returns void

Description
Method for changing current connection
Inherited from ProxyConnector.use
- Defined in packages/@biorate/connector/src/index.ts:105

Generated using TypeDoc