Add support for logs in sdk-node

[pksunkara]

Is your feature request related to a problem? Please describe.

With the recent implementation of logs, the purpose of sdk-node (of being the only single import) is no longer effective.

Describe the solution you'd like

Add support for logs in sdk-node library.

Describe alternatives you've considered

Additional context

[pksunkara]

@pichlermarc Can I please know whether this is in the plan or not? Is there any chat room where I can ask questions about this repo?

[pichlermarc]

I think this should be done at some point, yes. The Logs SDK is still rather new, so no one has gotten around to updating the sdk-node package yet. I'll mark this as up-for-grabs in case someone has cycles to pick this up - we'd definitely appreciate PRs adding this. 🙂

To ask questions, you can open a "Discussion" issue here or the discussions forum on the repo. Alternatively, there's also the CNCF Slack (https://slack.cncf.io/).

[psk001]

Hi @pichlermarc , as this issue is up for grabs , can I start working on it?

[pichlermarc]

@psk001 sure, go ahead 🙂 - it's yours 🎉

[psk001]

Great , I have set it up locally and running it . Could you please guide me a bit on how to proceed further ?

[pichlermarc]

Great , I have set it up locally and running it . Could you please guide me a bit on how to proceed further ?

Sure. 🙂 First, you'll need to add @opentelemetry/api-logs and @opentelemetry/sdk-logs as dependencies in @opentelemetry/sdk-node (make sure to use the latest version 0.40.0 so that lerna links the package from the monorepo). You'd need to add a way to set a logRecordProcessor to NodeSDKConfiguration. Then in the SDKNode class, you can keep track of it and use that LogRecordProcessor to instantiate a LogRecordProvider in the SDKNode.start(). Then register it with the logs API (@opentelemetry/api-logs) and that should be it. 🙂 Metrics is already there and adding logs would be a similar approach, so you can look at how we instantiate metrics in @opentelemetry/sdk-node and use that as a way to guide you through the process. If you do that, you can ignore everything related to Views as that concept does not exist for logs.

Once that is done, you can add tests, and then you should be ready to open a PR. Once you open the PR, you'll have to sign the Contributor License Agreement (a bot will ask you for it), and then the approvers will review the PR. 🙂

[psk001]

Got it, I'll proceed with it as suggested.

[psk001]

Sure. slightly_smiling_face First, you'll need to add @opentelemetry/api-logs and @opentelemetry/sdk-logs as dependencies in @opentelemetry/sdk-node (make sure to use the latest version 0.40.0 so that lerna links the package from the monorepo). You'd need to add a way to set a logRecordProcessor to NodeSDKConfiguration

This is added.
I'm using metric implementation as reference to implement logs as you said.
Metric uses MetricReader as shown below

export type MeterProviderConfig = { reader?: MetricReader; views?: View[]; };

Is logger in sdk-logs the right equivalent for MetricReader in sdk-metrics ?

export type LoggerProviderConfig = { logger?: Logger; }

is it correct?

[pichlermarc]

Sure. slightly_smiling_face First, you'll need to add @opentelemetry/api-logs and @opentelemetry/sdk-logs as dependencies in @opentelemetry/sdk-node (make sure to use the latest version 0.40.0 so that lerna links the package from the monorepo). You'd need to add a way to set a logRecordProcessor to NodeSDKConfiguration

This is added. I'm using metric implementation as reference to implement logs as you said. Metric uses MetricReader as shown below

export type MeterProviderConfig = { reader?: MetricReader; views?: View[]; };

Is logger in sdk-logs the right equivalent for MetricReader in sdk-metrics ?

export type LoggerProviderConfig = { logger?: Logger; }

is it correct?

It would be the LogRecordProcessor actually (and that one has an exporter attached to it 🙂)

export type LoggerProviderConfig = { logRecordProcessor?: LogRecordProcessor; }

[psk001]

OK got it, I missed that part.