feat(logger): use a pretty logger in locale development with OTel enabled

[10xLaCroixDrinker]

Description

Default to pretty logger in console when using OTel for local development. Keep option to use OTel's console exporter when --log-format=machine

I also got rid of the extra logs that are printed during unit tests

Motivation and Context

Make logs easier to consume during local dev when using OTel logging

How Has This Been Tested?

Ran the application with the following combinations:

• otel: enabled, NODE_ENV=production
• otel: disabled, NODE_ENV=production
• otel: enabled, NODE_ENV=development
• otel: enabled, NODE_ENV=development, --log-format=machine
• otel: disabled, NODE_ENV=development
• otel: disabled, NODE_ENV=development, --log-format=machine

New and existing unit tests

Types of Changes

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)
• Documentation (adding or updating documentation)
• Dependency update
• Security update

Checklist:

• My change requires a change to the documentation and I have updated the documentation accordingly.
• These changes should be applied to a maintenance branch.
• This change requires cross browser checks.
• Performance tests should be ran against the server prior to merging.
• This change impacts caching for client browsers.
• This change impacts HTTP headers.
• This change adds additional environment variable requirements for One App users.
• I have added the Apache 2.0 license header to any new files created.

What is the Impact to Developers Using One App?

More easily consumable logs by default during local dev when OTel is enabled

[github-actions]

Size Change: 0 B

Total Size: 719 kB

ℹ️ View Unchanged

Filename	Size
./build/app/app.js	171 kB
./build/app/app~vendors.js	410 kB
./build/app/runtime.js	7.07 kB
./build/app/service-worker-client.js	7.25 kB
./build/app/vendors.js	123 kB

_{compressed-size-action}

[giulianok]

this could be converted into a small fn to make it more modular and readable

Suggested change

	let transport;
	if (transportStreams.length === 1) {
	[transport] = transportStreams;
	} else if (transportStreams.length > 1) {
	transport = multistream(transportStreams);
	}
	const getTransport = (transportStreams = []) => {
	if (transportStreams.length === 1) return transportStreams[0];
	if (transportStreams.length > 1) return multistream(transportStreams);
	}
	...
	const transport = getTransport(transportStreams);

[giulianok]

what if transportStreams is an empty array?

[10xLaCroixDrinker]

if transportStreams is an empty array the variable is not used, and we passed undefined for the transport

[giulianok]

the problem with mutation, especially here, is that cases for transport streams and for pino config are different, I would convert them into functions to make it more readable, like

const getTransportStreams = () => {
  const transportStreams = [];

  if (process.env.OTEL_EXPORTER_OTLP_LOGS_ENDPOINT) {
    transportStreams.push(createOtelTransport({
      grpc: true,
      console: process.env.NODE_ENV === 'development' && argv.logFormat === 'machine',
    }));
  }

  if (!useProductionConfig) {
    // eslint-disable-next-line global-require -- do not load development logger in production
    transportStreams.push(require('./config/development').default);
  }

  return transportStreams;
}

const getPinoConfig = () => {
  if (process.env.OTEL_EXPORTER_OTLP_LOGS_ENDPOINT) {
    return deepmerge(baseConfig, otelConfig);
  }

  if (useProductionConfig) {
    return deepmerge(baseConfig, productionConfig);
  }

  return baseConfig
}

[JAdshead]

is this intended for logRecordProcessorOptions to either be empty array or array of objects or single object{} ?

[10xLaCroixDrinker]

Yes