RFC: naming convention of core utilities

[saragerion]

Description of the proposal

We need to come to an agreement about the naming convention of the core utilities, to keep them consistent within the wider TypeScript tools.

Name of the core utility (and consequently the folders that contain the libraries):

• packages/logger, packages/tracer, packages/meter
  OR
• packages/logs, packages/traces, packages/metrics
  OR
• packages/logging, packages/tracing, packages/metrics (?)

Name of Class that is used in the code to call the library:

• const logger = new Logger();, const tracer = new Tracer();, const meter = new Meter();
  OR
• const logs = new Logs();, const traces = new Traces();, const metrics = new Metrics();
  OR
• const logging = new Logging();, const tracing = new Tracing();, const metrics = new Metrics(); (?)

Related issues, RFCs

TODO: this needs to be created/moved in the official RFC repo: https://github.com/awslabs/aws-lambda-powertools-rfcs.
Adding this issue here for visibility and to open the conversation.

[heitorlessa]

Option C and A

packages/logging, packages/tracing, packages/metrics

Logger, Tracer, Metrics

These make it easier to import, same as Python, and easier on docs too ;)

Suuuuper excited and looking forward to this

[stale]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

[saragerion]

@alan-churley @dreamorosi what's your thought on this one? Feel free to leave a comment with your preference