Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Шаг 19 #38 #59

Merged
merged 6 commits into from
Jun 30, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
File renamed without changes.
21 changes: 3 additions & 18 deletions docs/docs/log.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,21 +55,6 @@ const middleware = logMiddleware({
client.use(middleware);
```

### Middleware для express-приложения

Аналогичная утилита предоставляется для express-приложений. Созданный промежуточный слой будет сообщать логгеру базовую информацию о входящем запросе и ответе.

```ts
import { logMiddleware } from '@sima-land/isomorph/http-server/middleware/log';
import { createLogger } from '@sima-land/isomorph/log';
import express from 'express';

const logger = createLogger();
const app = express();

app.use(config, logMiddleware(logger));
```

### Сбор ошибок

Для отслеживания ошибок мы используем преимущественно **Sentry**. Отправку ошибок и других событий в Sentry можно реализовать используя Logger со специальным обработчиком для Sentry.
Expand Down Expand Up @@ -97,11 +82,11 @@ logger.subscribe(createSentryHandler(sentryHub));
Любые данные, переданные логгеру через метод `error` также будут отправлены в Sentry.

```ts
import { SentryError, SentryBreadcrumb } from '@sima-land/isomorph/log';
import { DetailedError, Breadcrumb } from '@sima-land/isomorph/log';

// отправка ошибки
logger.error(
new SentryError('something wrong', {
new DetailedError('something wrong', {
extra: {
key: 'something',
data: 'wrong',
Expand All @@ -111,7 +96,7 @@ logger.error(

// отправка "хлебной крошки"
logger.info(
new SentryBreadcrumb({
new Breadcrumb({
category: 'something happens',
data: {
foo: 1,
Expand Down
69 changes: 0 additions & 69 deletions docs/docs/metrics.md

This file was deleted.

2 changes: 1 addition & 1 deletion docs/docs/tracing.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,6 @@ client.get('https://www.sima-land.ru/api/v3/user');

:::info Важно

При использовании DI-проложения с пресетом `PresetResponse` нет необходимости вручную конфигурировать промежуточные слои, а также трассировщик и контекст. Фабрика (доступна по токену `KnownToken.Http.Client.factory`) будет возвращать клиент, который уже связан с контекстом входящего запроса.
При использовании DI-проложения с пресетом `PresetHandler` нет необходимости вручную конфигурировать промежуточные слои, а также трассировщик и контекст. Фабрика (доступна по токену `KnownToken.Http.Client.factory`) будет возвращать клиент, который уже связан с контекстом входящего запроса.

:::
File renamed without changes.
File renamed without changes.
2 changes: 1 addition & 1 deletion src/config/index.ts
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
export { ConfigSource, BaseConfig } from './types';
export type { ConfigSource, BaseConfig } from './types';
export { createConfigSource } from './source';
export { createBaseConfig } from './base';
2 changes: 1 addition & 1 deletion src/di/index.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
export { Token, Resolve, Provider, Container, Application, Preset } from './types';
export type { Token, Resolve, Provider, Container, Application, Preset } from './types';
export { NothingBoundError, CircularDependencyError, AlreadyBoundError } from './errors';
export { createToken } from './token';
export { createContainer } from './container';
Expand Down
87 changes: 0 additions & 87 deletions src/http-server/middleware/metrics.ts

This file was deleted.

8 changes: 0 additions & 8 deletions src/metrics/constants.ts

This file was deleted.

44 changes: 0 additions & 44 deletions src/metrics/node.ts

This file was deleted.

87 changes: 69 additions & 18 deletions src/preset/node/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,6 @@ import { ConfigSource, createConfigSource } from '../../config';
import { createLogger } from '../../log';
import { createPinoHandler } from '../../log/handler/pino';
import { createSentryHandler } from '../../log/handler/sentry';
import {
responseMetricsMiddleware,
renderMetricsMiddleware,
} from '../../http-server/middleware/metrics';
import { HttpApiHostPool } from '../parts/utils';
import { KnownToken } from '../../tokens';
import { provideBaseConfig } from '../parts/providers';
Expand All @@ -25,7 +21,7 @@ import { config as applyDotenv } from 'dotenv';
import { create } from 'middleware-axios';
import { init, Handlers, getCurrentHub } from '@sentry/node';
import * as PromClient from 'prom-client';
import Express, { Application, Handler } from 'express';
import Express, { Application, Handler, Request, Response } from 'express';
import pino from 'pino';
import PinoPretty from 'pino-pretty';

Expand All @@ -42,9 +38,9 @@ import { NodeTracerProvider } from '@opentelemetry/sdk-trace-node';
import { Resource } from '@opentelemetry/resources';
import { SemanticResourceAttributes } from '@opentelemetry/semantic-conventions';
import { healthCheck } from '../../http-server/handler/health-check';
import { composeMiddleware, getXClientIp } from '../../http-server/utils';
import { createDefaultMetrics } from '../../metrics/node';
import { getXClientIp } from '../../http-server/utils';
import { toMilliseconds } from '../../utils/number';
import { RESPONSE_EVENT } from '../../http-server/constants';

/**
* Возвращает preset с зависимостями по умолчанию для frontend-микросервисов на Node.js.
Expand Down Expand Up @@ -233,17 +229,72 @@ export function provideHttpServerLogMiddleware(resolve: Resolve): Handler {

export function provideHttpServerMetricsMiddleware(resolve: Resolve): Handler {
const config = resolve(KnownToken.Config.base);
const metrics = createDefaultMetrics();

return composeMiddleware([
responseMetricsMiddleware(config, {
counter: metrics.requestCount,
histogram: metrics.responseDuration,
}),
renderMetricsMiddleware(config, {
histogram: metrics.renderDuration,
}),
]);

const ConventionalLabels = {
HTTP_RESPONSE: ['version', 'route', 'code', 'method'],
SSR: ['version', 'route', 'method'],
} as const;

const requestCount = new PromClient.Counter({
name: 'http_request_count',
help: 'Incoming HTTP request count',
labelNames: ConventionalLabels.HTTP_RESPONSE,
});

const responseDuration = new PromClient.Histogram({
name: 'http_response_duration_ms',
help: 'Duration of incoming HTTP requests in ms',
labelNames: ConventionalLabels.HTTP_RESPONSE,
buckets: [30, 100, 200, 500, 1000, 2500, 5000, 10000],
});

const renderDuration = new PromClient.Histogram({
name: 'render_duration_ms',
help: 'Duration of SSR ms',
labelNames: ConventionalLabels.SSR,
buckets: [0.1, 15, 50, 100, 250, 500, 800, 1500],
});

const getLabels = (
req: Request,
res: Response,
): Record<(typeof ConventionalLabels.HTTP_RESPONSE)[number], string | number> => ({
version: config.appVersion,
route: req.baseUrl + req.path,
code: res.statusCode,
method: req.method,
});

return (req, res, next) => {
const responseStart = process.hrtime.bigint();

requestCount.inc(getLabels(req, res), 1);

res.once(RESPONSE_EVENT.renderStart, () => {
const renderStart = process.hrtime.bigint();

res.once(RESPONSE_EVENT.renderFinish, () => {
const renderFinish = process.hrtime.bigint();

renderDuration.observe(
{
version: config.appVersion,
method: req.method,
route: req.baseUrl + req.path,
},
toMilliseconds(renderStart - renderFinish),
);
});
});

res.once('finish', () => {
const responseFinish = process.hrtime.bigint();

responseDuration.observe(getLabels(req, res), toMilliseconds(responseFinish - responseStart));
});

next();
};
}

export function provideHttpServerTracingMiddleware(resolve: Resolve): Handler {
Expand Down