pulsar icon indicating copy to clipboard operation
pulsar copied to clipboard

[Doc] Client configuration docs changes

Open peisenmann opened this issue 7 months ago • 0 comments

Search before reporting

  • [x] I searched in the issues and found nothing similar.

What issue do you find in Pulsar docs?

The docs page for the Node client does not seem to document:

  • useTLS: boolean
  • logLevel: 0, 1, 2, 3 (0 correlates to debug, 1=info, 2=warn, 3=error)

These are, however, captured in the TS types: https://github.com/apache/pulsar-client-node/blob/master/index.d.ts#L21

Further, these defaults are not captured anywhere as far as I can tell:

  • Default tlsTrustCertsFilePath is ${__dirname}/cert.pem per the default applied in the JS Client constructor: https://github.com/apache/pulsar-client-node/blob/master/src/Client.js#L24
  • Default log level is info per the C header file: https://github.com/apache/pulsar-client-node/blob/master/src/Client.h#L56

What is your suggestion?

I think documenting these things is enough. If there are other places where configurations are inferred or defaulted but not documented, it would be nice to find those and include them, too, but these are the ones I've come across so far.

Any reference?

No response

Are you willing to submit a PR?

  • [ ] I'm willing to submit a PR!

peisenmann avatar May 29 '25 16:05 peisenmann