[NP] Add meta-data and timestamp formatting for Log Record (#56982) (#…

…57419)

* log meta in pattern layout

* address pgayvallet comment

* add conversion patterns for timestamp

* use comparison instead of inline snapshots

* logs. use elasticsearch and LP compatible timezone format in json layout

* use regexp groups and dot separator for ms. as in default iso format

* use America/New_York timezone as default as it set in guess anyway

* fix APM tests. they need to reset timezone locally and restore it after

* fix logging tests

src/core/server/logging/layouts/conversions/context.ts

@@ -0,0 +1,34 @@
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you under
+ * the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+import chalk from 'chalk';
+
+import { Conversion } from './type';
+import { LogRecord } from '../../log_record';
+
+export const ContextConversion: Conversion = {
+  pattern: /{context}/gi,
+  formatter(record: LogRecord, highlight: boolean) {
+    let message = record.context;
+    if (highlight) {
+      message = chalk.magenta(message);
+    }
+    return message;
+  },
+};

src/core/server/logging/layouts/conversions/level.ts

@@ -0,0 +1,44 @@
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you under
+ * the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+import chalk from 'chalk';
+
+import { Conversion } from './type';
+import { LogLevel } from '../../log_level';
+import { LogRecord } from '../../log_record';
+
+const LEVEL_COLORS = new Map([
+  [LogLevel.Fatal, chalk.red],
+  [LogLevel.Error, chalk.red],
+  [LogLevel.Warn, chalk.yellow],
+  [LogLevel.Debug, chalk.green],
+  [LogLevel.Trace, chalk.blue],
+]);
+
+export const LevelConversion: Conversion = {
+  pattern: /{level}/gi,
+  formatter(record: LogRecord, highlight: boolean) {
+    let message = record.level.id.toUpperCase().padEnd(5);
+    if (highlight && LEVEL_COLORS.has(record.level)) {
+      const color = LEVEL_COLORS.get(record.level)!;
+      message = color(message);
+    }
+    return message;
+  },
+};

src/core/server/logging/layouts/conversions/message.ts

@@ -0,0 +1,29 @@
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you under
+ * the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+import { Conversion } from './type';
+import { LogRecord } from '../../log_record';
+
+export const MessageConversion: Conversion = {
+  pattern: /{message}/gi,
+  formatter(record: LogRecord) {
+    // Error stack is much more useful than just the message.
+    return (record.error && record.error.stack) || record.message;
+  },
+};

src/core/server/logging/layouts/conversions/meta.ts

@@ -0,0 +1,27 @@
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you under
+ * the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+import { Conversion } from './type';
+import { LogRecord } from '../../log_record';
+
+export const MetaConversion: Conversion = {
+  pattern: /{meta}/gi,
+  formatter(record: LogRecord) {
+    return record.meta ? `[${JSON.stringify(record.meta)}]` : '';
+  },
+};

src/core/server/logging/layouts/conversions/pid.ts

@@ -0,0 +1,28 @@
+/*
+ * Licensed to Elasticsearch B.V. under one or more contributor
+ * license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright
+ * ownership. Elasticsearch B.V. licenses this file to you under
+ * the Apache License, Version 2.0 (the "License"); you may
+ * not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+import { Conversion } from './type';
+import { LogRecord } from '../../log_record';
+
+export const PidConversion: Conversion = {
+  pattern: /{pid}/gi,
+  formatter(record: LogRecord) {
+    return String(record.pid);
+  },
+};