oracular (3) TSTextLogObjectCreate.3ts.gz

Provided by: trafficserver-dev_9.2.4+ds-2_amd64 bug

NAME
       TSTextLogObjectCreate - traffic Server text logging API


SYNOPSIS
          #include <ts/ts.h>

       TSReturnCode TSTextLogObjectCreate(const char *filename, int mode, TSTextLogObject *new_log_obj)

       TSReturnCode TSTextLogObjectWrite(TSTextLogObject the_object, const char *format, ...)

       void TSTextLogObjectFlush(TSTextLogObject the_object)

       TSReturnCode TSTextLogObjectDestroy(TSTextLogObject the_object)

       void TSTextLogObjectHeaderSet(TSTextLogObject the_object, const char *header)

       TSReturnCode TSTextLogObjectRollingEnabledSet(TSTextLogObject the_object, int rolling_enabled)

       void TSTextLogObjectRollingIntervalSecSet(TSTextLogObject the_object, int rolling_interval_sec)

       void TSTextLogObjectRollingOffsetHrSet(TSTextLogObject the_object, int rolling_offset_hr)

       void TSTextLogObjectRollingSizeMbSet(TSTextLogObject the_object, int rolling_size_mb)


DESCRIPTION
       TSTextLogObjectRollingEnabledSet()  sets the log rolling mode for the given object. This API must be used
       once the object is created and before writing into logs. The rolling_enabled argument  must  be  a  valid
       proxy.config.log.rolling_enabled  values.  If TSTextLogObjectRollingEnabledSet() is never called, the log
       object takes it's log rolling mode from the global proxy.config.log.rolling_enabled setting.

       It's also important to call TSTextLogObjectRollingEnabledSet() before any of the other APIs that modifies
       the rolling object. This is due to the fact that this API dictates which rolling mode should be used, and
       therefore affects further modifications of the logging object.


SEE ALSO
       TSAPI(3ts)


       2024, dev@trafficserver.apache.org