Skip to content
Draft
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
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -113,4 +113,5 @@ dev/tool/history.json
/combined_dependencies
.tmp
ws-tests/docker-compose.override.yml
.cursor/*
.cursor/*
CLAUDE.md
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,12 @@ For detailed information about the platform architecture, services, and their in
- [Docker](https://docs.docker.com/get-docker/)
- [Docker Compose](https://docs.docker.com/compose/install/)

If you use `nvm`, run this after entering the repo to align your shell with the repository Node version:

```bash
nvm use
```

## Verification

To verify the installation, perform the following checks in your terminal:
Expand Down
112 changes: 112 additions & 0 deletions common/config/rush/pnpm-lock.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 2 additions & 1 deletion common/scripts/docker.sh
Original file line number Diff line number Diff line change
Expand Up @@ -58,5 +58,6 @@ else
--to @hcengineering/pod-process \
--to @hcengineering/pod-rating \
--to @hcengineering/pod-payment \
--to @hcengineering/pod-worker
--to @hcengineering/pod-worker \
--to @hcengineering/pod-events-processor
fi
18 changes: 18 additions & 0 deletions dev/docker-compose.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -612,6 +612,24 @@ services:
- QUEUE_CONFIG=${QUEUE_CONFIG}
- QUEUE_REGION=cockroach
restart: unless-stopped
events-processor:
image: hardcoreeng/events-processor
extra_hosts:
- 'huly.local:host-gateway'
depends_on:
redpanda:
condition: service_started
account:
condition: service_started
environment:
- SERVICE_ID=events-processor
- LOG_LEVEL=debug
- SECRET=secret
- ACCOUNTS_URL=http://huly.local:3000
- QUEUE_CONFIG=${QUEUE_CONFIG}
- QUEUE_REGION=cockroach
- OTEL_EXPORTER_OTLP_ENDPOINT=http://jaeger:4318/v1/traces
restart: unless-stopped
# translate:
# image: hardcoreeng/translate
# extra_hosts:
Expand Down
9 changes: 8 additions & 1 deletion foundations/core/packages/analytics-service/src/logging.ts
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ export class SplitLogger implements MeasureLogger {
const rootDir = this.opts.root ?? 'logs'

this.logger = winston.createLogger({
level: 'info',
level: process.env.LOG_LEVEL === 'debug' ? 'debug' : 'info',
exitOnError: false
})
const errorPrinter = ({ message, stack, ...rest }: Error): object => ({
Expand Down Expand Up @@ -99,6 +99,13 @@ export class SplitLogger implements MeasureLogger {
this.logger.warn({ message, ...obj })
}

debug (message: string, obj?: Record<string, any>): void {
if (this.opts.parent !== undefined) {
this.opts.parent.debug({ message, ...obj })
}
this.logger.debug({ message, ...obj })
}

logOperation (operation: string, time: number, params: ParamsType): void {
this.logger.info(operation, { time, ...params })
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ describe('telemetry', () => {
info: jest.fn(),
error: jest.fn(),
warn: jest.fn(),
debug: jest.fn(),
close: jest.fn(async () => {}),
logOperation: jest.fn()
}
Expand Down
33 changes: 29 additions & 4 deletions foundations/core/packages/measurements-otlp/src/telemetry.ts
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ import {
updateMeasure,
type FullParamsType,
type MeasureLogger,
type MeasureLogLevel,
type Metrics,
type ParamsType,
type WithOptions
Expand Down Expand Up @@ -97,7 +98,8 @@ export class OpenTelemetryMetricsContext implements MeasureContext {
readonly logParams?: ParamsType,

readonly otlpLogger?: Logger,
readonly meter?: MetricsContext
readonly meter?: MetricsContext,
readonly logLevel: MeasureLogLevel = 'info'
) {
this.name = name
this.params = params
Expand Down Expand Up @@ -133,6 +135,7 @@ export class OpenTelemetryMetricsContext implements MeasureContext {
logger?: MeasureLogger
span?: WithOptions['span'] // By default true
meta?: Record<string, string | number | boolean>
logLevel?: MeasureLogLevel
}
): MeasureContext {
let _span: Span | undefined
Expand Down Expand Up @@ -170,7 +173,8 @@ export class OpenTelemetryMetricsContext implements MeasureContext {
this,
this.logParams,
this.otlpLogger,
this.meter
this.meter,
opt?.logLevel ?? this.logLevel
)
result.id = this.id
result.contextData = this.contextData
Expand Down Expand Up @@ -309,6 +313,23 @@ export class OpenTelemetryMetricsContext implements MeasureContext {
this.logger.warn(message, { ...this.params, ...args, ...(this.logParams ?? {}) })
}

debug (message: string, args?: Record<string, any>): void {
if (this.logLevel !== 'debug') return
if (this.otlpLogger !== undefined) {
this.otlpLogger.emit({
severityNumber: SeverityNumber.DEBUG,
severityText: 'debug',
context: this.context,
body: message,
attributes: {
'service.name': sdkServiceName,
...(args ?? {})
}
})
}
this.logger.debug(message, { ...this.params, ...args, ...(this.logParams ?? {}) })
}

end (): void {
this.done()
}
Expand Down Expand Up @@ -530,7 +551,8 @@ export function createOpenTelemetryMetricsContext (
): MeasureContext {
if (!initOpenTelemetrySDK(name, version ?? '')) {
console.warn('OTEL_EXPORTER_OTLP_TRACES_ENDPOINT is not set, OpenTelemetry metrics will not be sent')
return new MeasureMetricsContext(name, params, fullParams, metrics, logger)
const rootLogLevel: MeasureLogLevel = process.env.LOG_LEVEL === 'debug' ? 'debug' : 'info'
return new MeasureMetricsContext(name, params, fullParams, metrics, logger, undefined, undefined, rootLogLevel)
}

// Traces
Expand All @@ -542,6 +564,8 @@ export function createOpenTelemetryMetricsContext (

const meter = otelMetrics.getMeter(name, version)

const rootLogLevel: MeasureLogLevel = process.env.LOG_LEVEL === 'debug' ? 'debug' : 'info'

const ctx = new OpenTelemetryMetricsContext(
name,
tracer,
Expand All @@ -554,7 +578,8 @@ export function createOpenTelemetryMetricsContext (
undefined,
undefined,
otlpLogger,
new MetricsContext(meter)
new MetricsContext(meter),
rootLogLevel
)
return ctx
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ describe('context', () => {
expect(typeof logger.info).toBe('function')
expect(typeof logger.error).toBe('function')
expect(typeof logger.warn).toBe('function')
expect(typeof logger.debug).toBe('function')
expect(typeof logger.close).toBe('function')
})

Expand Down Expand Up @@ -54,6 +55,16 @@ describe('context', () => {
consoleSpy.mockRestore()
})

it('should log debug messages', () => {
const consoleSpy = jest.spyOn(console, 'debug').mockImplementation()
const logger = consoleLogger({ service: 'test' })

logger.debug('Debug message', { detail: 'x' })

expect(consoleSpy).toHaveBeenCalled()
consoleSpy.mockRestore()
})

it('should handle errors in params', () => {
const consoleSpy = jest.spyOn(console, 'error').mockImplementation()
const logger = consoleLogger({})
Expand Down Expand Up @@ -145,6 +156,7 @@ describe('context', () => {
info: jest.fn(),
error: jest.fn(),
warn: jest.fn(),
debug: jest.fn(),
close: jest.fn(async () => {}),
logOperation: jest.fn()
}
Expand All @@ -163,6 +175,7 @@ describe('context', () => {
info: jest.fn(),
error: jest.fn(),
warn: jest.fn(),
debug: jest.fn(),
close: jest.fn(async () => {}),
logOperation: jest.fn()
}
Expand All @@ -181,6 +194,7 @@ describe('context', () => {
info: jest.fn(),
error: jest.fn(),
warn: jest.fn(),
debug: jest.fn(),
close: jest.fn(async () => {}),
logOperation: jest.fn()
}
Expand All @@ -194,6 +208,47 @@ describe('context', () => {
)
})

it('should not log debug when log level is info', () => {
const mockLogger: MeasureLogger = {
info: jest.fn(),
error: jest.fn(),
warn: jest.fn(),
debug: jest.fn(),
close: jest.fn(async () => {}),
logOperation: jest.fn()
}

const ctx = new MeasureMetricsContext('test', { op: 'test' }, {}, newMetrics(), mockLogger)
ctx.debug('Skip', { k: 1 })

expect(mockLogger.debug).not.toHaveBeenCalled()
})

it('should log debug when log level is debug', () => {
const mockLogger: MeasureLogger = {
info: jest.fn(),
error: jest.fn(),
warn: jest.fn(),
debug: jest.fn(),
close: jest.fn(async () => {}),
logOperation: jest.fn()
}

const ctx = new MeasureMetricsContext(
'test',
{ op: 'test' },
{},
newMetrics(),
mockLogger,
undefined,
undefined,
'debug'
)
ctx.debug('D', { k: 1 })

expect(mockLogger.debug).toHaveBeenCalledWith('D', expect.objectContaining({ k: 1, op: 'test' }))
})

it('should get params', () => {
const ctx = new MeasureMetricsContext('test', { op: 'test', method: 'GET' }, {}, newMetrics(), logger)
const params = ctx.getParams()
Expand Down Expand Up @@ -440,6 +495,7 @@ describe('context', () => {
info: jest.fn(),
error: jest.fn(),
warn: jest.fn(),
debug: jest.fn(),
close: jest.fn(async () => {}),
logOperation: jest.fn()
}
Expand Down
Loading
Loading