Class AxiosPrometheus`Abstract`

Description

Axios-prometheus HTTP interface

Features:

Metrics of you HTTP requests out of the box

Example

import { container, Types } from '@biorate/inversion';
import { IConfig, Config } from '@biorate/config';
import { AxiosPrometheus } from '@biorate/axios-prometheus';

export class Google extends AxiosPrometheus {
  public baseURL = this.config.get<string>('baseURL');
  public url = '/';
  public method = 'get';
  public timeout = 1500;
}

container.bind(Types.Config).to(Config).inSingletonScope();

container.get<IConfig>(Types.Config).merge({
  baseURL: 'https://google.com',
});

(async () => {
  await Google.fetch();
})();

Hierarchy (view full)

Axios
- AxiosPrometheus

Index

Constructors

`Protected` constructor

new AxiosPrometheus(): AxiosPrometheus
Returns AxiosPrometheus
Inherited from Axios.constructor
- Defined in packages/@biorate/singleton/dist/types/src/index.d.ts:4

Properties

`Private` #private

#private: any

`Abstract` baseURL

baseURL: string

`Protected` counter

counter: Counter<string>

`Abstract` method

method: string

timeout

timeout: number

`Abstract` url

url: string

`Static` `Private` #histogram

#histogram: Histogram<string>

`Static` `Protected` aspectAliases

aspectAliases: Record<string, string> = ...

Description

Aliases accepted in tracing.excludedAttributes for aspect matching

`Static` `Protected` cache

cache: WeakMap<typeof Singleton, Singleton>

`Static` `Protected` mockFields

mockFields: string[] = ...

`Static` `Protected` mocks

mocks: WeakMap<typeof Axios, {
value: boolean;
}>

Type declaration

value: boolean

Accessors

`Protected` config

get config(): IConfig
Returns IConfig
- Defined in packages/@biorate/axios-prometheus/src/index.ts:147

`Protected` histogram

get histogram(): Histogram<string>
Returns Histogram<string>
- Defined in packages/@biorate/axios-prometheus/src/index.ts:132

`Static` defaults

get defaults(): Omit<AxiosDefaults<any>, "headers"> & {
    headers: HeadersDefaults & {
        [key: string]: AxiosHeaderValue;
    };
}
Returns Omit<AxiosDefaults<any>, "headers"> & {
    headers: HeadersDefaults & {
        [key: string]: AxiosHeaderValue;
    };
}
Inherited from Axios.defaults
- Defined in packages/@biorate/axios/dist/types/src/index.d.ts:18

`Static` options

get options(): Options
Returns Options
Inherited from Axios.options
- Defined in packages/@biorate/axios/dist/types/src/index.d.ts:13

`Static` `Protected` stubs

get stubs(): Stubs
Returns Stubs
Inherited from Axios.stubs
- Defined in packages/@biorate/axios/dist/types/src/index.d.ts:12

Methods

`Protected` after

after(result, startTime, params, meta?): Promise<void>
Parameters
- result: AxiosResponse<any, any, {}>
- startTime: [number, number]
- params: IAxiosFetchOptions
- Optional meta: Record<string, unknown>
Returns Promise<void>
Overrides Axios.after
- Defined in packages/@biorate/axios-prometheus/src/index.ts:299

`Protected` before

before(params?, meta?): Promise<void>
Parameters
- Optional params: IAxiosFetchOptions
- Optional meta: Record<string, unknown>
Returns Promise<void>
Overrides Axios.before
- Defined in packages/@biorate/axios-prometheus/src/index.ts:273

`Protected` catch

catch(e, startTime, params, meta?): Promise<void>
Parameters
- e: Error | AxiosError<unknown, any>
- startTime: [number, number]
- params: IAxiosFetchOptions
- Optional meta: Record<string, unknown>
Returns Promise<void>
Overrides Axios.catch
- Defined in packages/@biorate/axios-prometheus/src/index.ts:318

`Protected` fetch

fetch<T, D>(options?): Promise<AxiosResponse<T, D, {}>>
Type Parameters
- T
- D
Parameters
- Optional options: IAxiosFetchOptions
Returns Promise<AxiosResponse<T, D, {}>>
Inherited from Axios.fetch
- Defined in packages/@biorate/axios/dist/types/src/index.d.ts:27

`Protected` finally

finally(startTime, params?, meta?): Promise<void>
Parameters
- startTime: [number, number]
- Optional params: IAxiosFetchOptions
- Optional meta: Record<string, unknown>
Returns Promise<void>
Overrides Axios.finally
- Defined in packages/@biorate/axios-prometheus/src/index.ts:344

`Protected` fullUrl

fullUrl(params?): string
Parameters
- Optional params: IAxiosFetchOptions
Returns string
Description
Get full url = baseURL + url
- Defined in packages/@biorate/axios-prometheus/src/index.ts:215

`Protected` getStartTime

getStartTime(): [number, number]
Returns [number, number]
Description
Get start time method
Overrides Axios.getStartTime
- Defined in packages/@biorate/axios-prometheus/src/index.ts:166

`Protected` log

log(statusCode, startTime): void
Parameters
- statusCode: number
- startTime: [number, number]
Returns void
Description
Log method
- Defined in packages/@biorate/axios-prometheus/src/index.ts:172

`Protected` needAttribute

needAttribute(url, name): boolean
Parameters
- url: string
- name: string
Returns boolean
Description
Check need to trace a concrete span aspect (AxiosPrometheus.tracing.excludedAttributes globally and AxiosPrometheus.tracing.excludedByURL per-URL). An excluded item also matches aspect groups by prefix, e.g. response excludes response.headers, response.statusCode and response.data.
- Defined in packages/@biorate/axios-prometheus/src/index.ts:247

`Protected` needTrace

needTrace(url, span?): boolean
Parameters
- url: string
- Optional span: Span
Returns boolean
Description
Check need to trace
- Defined in packages/@biorate/axios-prometheus/src/index.ts:200

`Protected` stringify

stringify(data): string
Parameters
- data: unknown
Returns string
Description
Stringify data
- Defined in packages/@biorate/axios-prometheus/src/index.ts:194

`Static` `Protected` _fetch

_fetch<T, D>(options?): Promise<AxiosResponse<T, D, {}>>
Type Parameters
- T = any
- D = any
Parameters
- Optional options: IAxiosFetchOptions
Returns Promise<AxiosResponse<T, D, {}>>
Inherited from Axios._fetch
- Defined in packages/@biorate/axios/dist/types/src/index.d.ts:25

`Static` `Protected` checkMockDir

checkMockDir(directory): string
Parameters
- directory: string
Returns string
- Defined in packages/@biorate/axios-prometheus/src/index.ts:50

`Static` fetch

fetch(options?): Promise<AxiosResponse<any, any, {}>>
Parameters
- Optional options: any
Returns Promise<AxiosResponse<any, any, {}>>
Inherited from Axios.fetch
- Defined in packages/@biorate/axios/dist/types/src/index.d.ts:14

`Static` `Protected` getMock

getMock<T, D>(instance, options?): AxiosResponse<T, D, {}>
Type Parameters
- T = any
- D = any
Parameters
- instance: Axios
- Optional options: IAxiosFetchOptions
Returns AxiosResponse<T, D, {}>
Overrides Axios.getMock
- Defined in packages/@biorate/axios-prometheus/src/index.ts:76

`Static` `Protected` getMockData

getMockData(instance, filename): any
Parameters
- instance: Axios
- filename: string
Returns any
- Defined in packages/@biorate/axios-prometheus/src/index.ts:72

`Static` `Protected` instance

instance<T>(): T
Type Parameters
- T
Returns T
Inherited from Axios.instance
- Defined in packages/@biorate/singleton/dist/types/src/index.d.ts:3

`Static` `Protected` mockFileName

mockFileName(name): string
Parameters
- name: string
Returns string
- Defined in packages/@biorate/axios-prometheus/src/index.ts:46

`Static` `Protected` mockFilePath

mockFilePath(filename?): string
Parameters
- Optional filename: string
Returns string
- Defined in packages/@biorate/axios-prometheus/src/index.ts:61

`Static` `Protected` normalizeAspect

normalizeAspect(name): string
Parameters
- name: string
Returns string
Description
Normalize an aspect name to its canonical form
- Defined in packages/@biorate/axios-prometheus/src/index.ts:234

`Static` `Protected` setMock

setMock<T, D>(instance, result, options?): void
Type Parameters
- T = any
- D = any
Parameters
- instance: Axios
- result: AxiosResponse<T, D, {}>
- Optional options: IAxiosFetchOptions
Returns void
Overrides Axios.setMock
- Defined in packages/@biorate/axios-prometheus/src/index.ts:95

`Static` stub

stub(params, persist?): void
Parameters
- params: IStubParam
- Optional persist: boolean
Returns void
Inherited from Axios.stub
- Defined in packages/@biorate/axios/dist/types/src/index.d.ts:15

`Static` unstub

unstub(): void
Returns void
Inherited from Axios.unstub
- Defined in packages/@biorate/axios/dist/types/src/index.d.ts:16

`Static` useMock

useMock(): void
Returns void
Inherited from Axios.useMock
- Defined in packages/@biorate/axios/dist/types/src/index.d.ts:17

Class AxiosPrometheusAbstract

Description

Features:

Example

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

Protected constructor

Returns AxiosPrometheus

Properties

Private #private

Abstract baseURL

Protected counter

Abstract method

timeout

Abstract url

Static Private #histogram

Static Protected aspectAliases

Description

Static Protected cache

Static Protected mockFields

Static Protected mocks

Type declaration

value: boolean

Accessors

Protected config

Returns IConfig

Protected histogram

Returns Histogram<string>

Static defaults

Returns Omit<AxiosDefaults<any>, "headers"> & { headers: HeadersDefaults & { [key: string]: AxiosHeaderValue; }; }

Static options

Returns Options

Static Protected stubs

Returns Stubs

Methods

Protected after

Parameters

Returns Promise<void>

Protected before

Parameters

Returns Promise<void>

Protected catch

Parameters

Returns Promise<void>

Protected fetch

Type Parameters

Parameters

Returns Promise<AxiosResponse<T, D, {}>>

Protected finally

Parameters

Returns Promise<void>

Protected fullUrl

Parameters

Returns string

Description

Protected getStartTime

Returns [number, number]

Description

Protected log

Parameters

Returns void

Description

Protected needAttribute

Parameters

Returns boolean

Description

Protected needTrace

Parameters

Returns boolean

Description

Protected stringify

Parameters

Returns string

Description

Static Protected _fetch

Class AxiosPrometheus`Abstract`

`Protected` constructor

`Private` #private

`Abstract` baseURL

`Protected` counter

`Abstract` method

`Abstract` url

`Static` `Private` #histogram

`Static` `Protected` aspectAliases

`Static` `Protected` cache

`Static` `Protected` mockFields

`Static` `Protected` mocks

`Protected` config

`Protected` histogram

`Static` defaults

Returns Omit<AxiosDefaults<any>, "headers"> & {
headers: HeadersDefaults & {
[key: string]: AxiosHeaderValue;
};
}

`Static` options

`Static` `Protected` stubs

`Protected` after

`Protected` before

`Protected` catch

`Protected` fetch

`Protected` finally

`Protected` fullUrl

`Protected` getStartTime

`Protected` log

`Protected` needAttribute

`Protected` needTrace

`Protected` stringify

`Static` `Protected` _fetch

`Static` `Protected` checkMockDir

`Static` fetch

`Static` `Protected` getMock

`Static` `Protected` getMockData

`Static` `Protected` instance

`Static` `Protected` mockFileName

`Static` `Protected` mockFilePath

`Static` `Protected` normalizeAspect

`Static` `Protected` setMock

`Static` stub

`Static` unstub

`Static` useMock