mirror of
https://github.com/apache/nuttx.git
synced 2026-05-18 17:18:28 +08:00
liwangzhu
19fa9c1c67
This commit introduces a new Kconfig option SYSLOG_TIMESTAMP_MS to allowconfiguring syslog timestamps to use milliseconds (ms) instead of the default microseconds (µs). Key changes: 1. Add CONFIG_SYSLOG_TIMESTAMP_MS boolean Kconfig option (depends on SYSLOG_TIMESTAMP), default disabled. This option lets users choose between millisecond and microsecond precision in syslog timestamps. 2. Modify the timestamp format string in nx_vsyslog(): a. When CONFIG_SYSLOG_TIMESTAMP_MS is enabled: Use [%5ju.%03ld] (3 digits for ms). b. When disabled (default): Retain original [%5ju.%06ld] (6 digits for µs). 3. Adjust the timestamp value calculation: a. For ms: Divide nanoseconds by NSEC_PER_MSEC (1,000,000) to get millisecond value. b. For µs (default): Retain division by NSEC_PER_USEC (1,000) for microsecond value. This enhancement provides flexibility in syslog timestamp precision: 1. Millisecond precision reduces log line length and is sufficient for many use cases. 2. Maintains backward compatibility (microseconds remain the default). 3. The Kconfig dependency ensures the option is only visible when timestamps are enabled. The change is fully conditional and has no impact on existing behavior unless the new option is explicitly enabled. Signed-off-by: liwangzhu <liwangzhu@bytedance.com> Signed-off-by: chao an <anchao.archer@bytedance.com>
286 lines
7.9 KiB
C
286 lines
7.9 KiB
C
/****************************************************************************
|
|
* drivers/syslog/vsyslog.c
|
|
*
|
|
* SPDX-License-Identifier: Apache-2.0
|
|
*
|
|
* Licensed to the Apache Software Foundation (ASF) under one or more
|
|
* contributor license agreements. See the NOTICE file distributed with
|
|
* this work for additional information regarding copyright ownership. The
|
|
* ASF 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.
|
|
*
|
|
****************************************************************************/
|
|
|
|
/****************************************************************************
|
|
* Included Files
|
|
****************************************************************************/
|
|
|
|
#include <nuttx/config.h>
|
|
|
|
#include <stdio.h>
|
|
#include <syslog.h>
|
|
#include <errno.h>
|
|
|
|
#include <nuttx/arch.h>
|
|
#include <nuttx/init.h>
|
|
#include <nuttx/clock.h>
|
|
#include <nuttx/streams.h>
|
|
#include <nuttx/syslog/syslog.h>
|
|
|
|
#include "syslog.h"
|
|
|
|
/****************************************************************************
|
|
* Private Data
|
|
****************************************************************************/
|
|
|
|
#if defined(CONFIG_SYSLOG_COLOR_OUTPUT)
|
|
static FAR const char * const g_priority_color[] =
|
|
{
|
|
"\e[31;1;5m", /* LOG_EMERG, Red, Bold, Blinking */
|
|
"\e[31;1m", /* LOG_ALERT, Red, Bold */
|
|
"\e[31;1m", /* LOG_CRIT, Red, Bold */
|
|
"\e[31m", /* LOG_ERR, Red */
|
|
"\e[33m", /* LOG_WARNING, Yellow */
|
|
"\e[1m", /* LOG_NOTICE, Bold */
|
|
"", /* LOG_INFO, Normal */
|
|
"\e[2m", /* LOG_DEBUG, Dim */
|
|
};
|
|
#endif
|
|
|
|
#if defined(CONFIG_SYSLOG_PRIORITY)
|
|
static FAR const char * const g_priority_str[] =
|
|
{
|
|
"EMERG", "ALERT", "CRIT", "ERROR",
|
|
"WARN", "NOTICE", "INFO", "DEBUG"
|
|
};
|
|
#endif
|
|
|
|
/****************************************************************************
|
|
* Public Functions
|
|
****************************************************************************/
|
|
|
|
/****************************************************************************
|
|
* Name: nx_vsyslog
|
|
*
|
|
* Description:
|
|
* nx_vsyslog() handles the system logging system calls. It is functionally
|
|
* equivalent to vsyslog() except that (1) the per-process priority
|
|
* filtering has already been performed and the va_list parameter is
|
|
* passed by reference. That is because the va_list is a structure in
|
|
* some compilers and passing of structures in the NuttX sycalls does
|
|
* not work.
|
|
*
|
|
****************************************************************************/
|
|
|
|
int nx_vsyslog(int priority, FAR const IPTR char *fmt, FAR va_list *ap)
|
|
{
|
|
struct lib_syslograwstream_s stream;
|
|
int ret = 0;
|
|
#ifdef CONFIG_SYSLOG_PROCESS_NAME
|
|
FAR struct tcb_s *tcb = nxsched_self();
|
|
#endif
|
|
#ifdef CONFIG_SYSLOG_TIMESTAMP
|
|
struct timespec ts;
|
|
# if defined(CONFIG_SYSLOG_TIMESTAMP_FORMATTED)
|
|
struct tm tm;
|
|
char date_buf[CONFIG_SYSLOG_TIMESTAMP_BUFFER];
|
|
# endif
|
|
#endif
|
|
|
|
/* Wrap the low-level output in a stream object and let lib_vsprintf
|
|
* do the work.
|
|
*/
|
|
|
|
lib_syslograwstream_open(&stream);
|
|
|
|
#ifdef CONFIG_SYSLOG_TIMESTAMP
|
|
ts.tv_sec = 0;
|
|
ts.tv_nsec = 0;
|
|
|
|
# if defined(CONFIG_SYSLOG_TIMESTAMP_FORMATTED)
|
|
memset(&tm, 0, sizeof(tm));
|
|
# endif
|
|
|
|
/* Get the current time. Since debug output may be generated very early
|
|
* in the start-up sequence, hardware timer support may not yet be
|
|
* available.
|
|
*/
|
|
|
|
if (OSINIT_HW_READY())
|
|
{
|
|
# if defined(CONFIG_SYSLOG_TIMESTAMP_REALTIME)
|
|
/* Use CLOCK_REALTIME if so configured */
|
|
|
|
clock_gettime(CLOCK_REALTIME, &ts);
|
|
# else
|
|
/* Prefer monotonic when enabled, as it can be synchronized to
|
|
* RTC with clock_resynchronize.
|
|
*/
|
|
|
|
clock_gettime(CLOCK_MONOTONIC, &ts);
|
|
# endif
|
|
|
|
/* Prepend the message with the current time, if available */
|
|
|
|
# if defined(CONFIG_SYSLOG_TIMESTAMP_FORMATTED)
|
|
# if defined(CONFIG_SYSLOG_TIMESTAMP_LOCALTIME)
|
|
localtime_r(&ts.tv_sec, &tm);
|
|
# else
|
|
gmtime_r(&ts.tv_sec, &tm);
|
|
# endif
|
|
# endif
|
|
}
|
|
|
|
# if defined(CONFIG_SYSLOG_TIMESTAMP_FORMATTED)
|
|
date_buf[0] = '\0';
|
|
strftime(date_buf, CONFIG_SYSLOG_TIMESTAMP_BUFFER,
|
|
CONFIG_SYSLOG_TIMESTAMP_FORMAT, &tm);
|
|
# endif
|
|
#endif
|
|
|
|
#if defined(CONFIG_SYSLOG_COLOR_OUTPUT) || defined(CONFIG_SYSLOG_TIMESTAMP) || \
|
|
defined(CONFIG_SMP) || defined(CONFIG_SYSLOG_PROCESSID) || \
|
|
defined(CONFIG_SYSLOG_PRIORITY) || defined(CONFIG_SYSLOG_PREFIX) || \
|
|
defined(CONFIG_SYSLOG_PROCESS_NAME)
|
|
|
|
ret = lib_sprintf_internal(&stream.common,
|
|
#if defined(CONFIG_SYSLOG_COLOR_OUTPUT)
|
|
/* Reset the terminal style. */
|
|
|
|
"\e[0m"
|
|
#endif
|
|
|
|
#ifdef CONFIG_SYSLOG_TIMESTAMP
|
|
# if defined(CONFIG_SYSLOG_TIMESTAMP_FORMATTED)
|
|
# if defined(CONFIG_SYSLOG_TIMESTAMP_FORMAT_MICROSECOND)
|
|
"[%s.%06ld] "
|
|
# else
|
|
"[%s] "
|
|
# endif
|
|
# else
|
|
# if defined(CONFIG_SYSLOG_TIMESTAMP_MS)
|
|
"[%5ju.%03ld] "
|
|
# else
|
|
"[%5ju.%06ld] "
|
|
# endif
|
|
# endif
|
|
#endif
|
|
|
|
#if defined(CONFIG_SMP)
|
|
"[CPU%d] "
|
|
#endif
|
|
|
|
#if defined(CONFIG_SYSLOG_PROCESSID)
|
|
/* Prepend the Thread ID */
|
|
|
|
"[%2d] "
|
|
#endif
|
|
|
|
#if defined(CONFIG_SYSLOG_COLOR_OUTPUT)
|
|
/* Set the terminal style according to message priority. */
|
|
|
|
"%s"
|
|
#endif
|
|
|
|
#if defined(CONFIG_SYSLOG_PRIORITY)
|
|
/* Prepend the message priority. */
|
|
|
|
"[%6s] "
|
|
#endif
|
|
|
|
#if defined(CONFIG_SYSLOG_PREFIX)
|
|
/* Prepend the prefix, if available */
|
|
|
|
"[%s] "
|
|
#endif
|
|
#ifdef CONFIG_SYSLOG_PROCESS_NAME
|
|
/* Prepend the thread name */
|
|
|
|
"%s: "
|
|
#endif
|
|
#ifdef CONFIG_SYSLOG_TIMESTAMP
|
|
# if defined(CONFIG_SYSLOG_TIMESTAMP_FORMATTED)
|
|
# if defined(CONFIG_SYSLOG_TIMESTAMP_FORMAT_MICROSECOND)
|
|
, date_buf, ts.tv_nsec / NSEC_PER_USEC
|
|
# else
|
|
, date_buf
|
|
# endif
|
|
# else
|
|
# if defined(CONFIG_SYSLOG_TIMESTAMP_MS)
|
|
, (uintmax_t)ts.tv_sec
|
|
, ts.tv_nsec / NSEC_PER_MSEC
|
|
# else
|
|
, (uintmax_t)ts.tv_sec
|
|
, ts.tv_nsec / NSEC_PER_USEC
|
|
# endif
|
|
# endif
|
|
#endif
|
|
|
|
#if defined(CONFIG_SMP)
|
|
, this_cpu()
|
|
#endif
|
|
|
|
#if defined(CONFIG_SYSLOG_PROCESSID)
|
|
/* Prepend the Thread ID */
|
|
|
|
, nxsched_gettid()
|
|
#endif
|
|
|
|
#if defined(CONFIG_SYSLOG_COLOR_OUTPUT)
|
|
/* Set the terminal style according to message priority. */
|
|
|
|
, g_priority_color[LOG_PRI(priority)]
|
|
#endif
|
|
|
|
#if defined(CONFIG_SYSLOG_PRIORITY)
|
|
/* Prepend the message priority. */
|
|
|
|
, g_priority_str[LOG_PRI(priority)]
|
|
#endif
|
|
|
|
#if defined(CONFIG_SYSLOG_PREFIX)
|
|
/* Prepend the prefix, if available */
|
|
|
|
, CONFIG_SYSLOG_PREFIX_STRING
|
|
#endif
|
|
|
|
#ifdef CONFIG_SYSLOG_PROCESS_NAME
|
|
/* Prepend the thread name */
|
|
|
|
, get_task_name(tcb)
|
|
#endif
|
|
);
|
|
|
|
#endif /* CONFIG_SYSLOG_COLOR_OUTPUT || CONFIG_SYSLOG_TIMESTAMP || ... */
|
|
|
|
/* Generate the output */
|
|
|
|
ret += lib_vsprintf_internal(&stream.common, fmt, *ap);
|
|
|
|
if (stream.last_ch != '\n')
|
|
{
|
|
lib_stream_putc(&stream.common, '\n');
|
|
ret++;
|
|
}
|
|
|
|
#if defined(CONFIG_SYSLOG_COLOR_OUTPUT)
|
|
/* Reset the terminal style back to normal. */
|
|
|
|
ret += lib_stream_puts(&stream.common, "\e[0m", sizeof("\e[0m"));
|
|
#endif
|
|
|
|
/* Flush and destroy the syslog stream buffer */
|
|
|
|
lib_syslograwstream_close(&stream);
|
|
return ret;
|
|
}
|