devinbost commented on a change in pull request #10617:
URL: https://github.com/apache/pulsar/pull/10617#discussion_r634033526
##########
File path: site2/docs/functions-develop.md
##########
@@ -656,6 +656,182 @@ $ bin/pulsar-admin functions create \
All logs produced by `LoggingFunction` above can be accessed via the
`persistent://public/default/logging-function-logs` topic.
+#### Customizing Function Log Level
+Additionally, you can use the XML file, `functions_log4j2.xml`, to customize
the function log level.
+To customize the function log level, create or update `functions_log4j2.xml`
in your Pulsar conf directory (e.g. `/etc/pulsar/`) to contain contents such as:
+
+```xml
+<Configuration>
+ <name>pulsar-functions-instance</name>
+ <monitorInterval>30</monitorInterval>
+ <Properties>
+ <Property>
+ <name>pulsar.log.appender</name>
+ <value>RollingFile</value>
+ </Property>
+ <Property>
+ <name>pulsar.log.level</name>
+ <value>debug</value>
+ </Property>
+ <Property>
+ <name>bk.log.level</name>
+ <value>debug</value>
+ </Property>
+ </Properties>
+ <Appenders>
+ <Console>
+ <name>Console</name>
+ <target>SYSTEM_OUT</target>
+ <PatternLayout>
+ <Pattern>%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} -
%msg%n</Pattern>
+ </PatternLayout>
+ </Console>
+ <RollingFile>
+ <name>RollingFile</name>
+
<fileName>${sys:pulsar.function.log.dir}/${sys:pulsar.function.log.file}.log</fileName>
+
<filePattern>${sys:pulsar.function.log.dir}/${sys:pulsar.function.log.file}-%d{MM-dd-yyyy}-%i.log.gz</filePattern>
+ <immediateFlush>true</immediateFlush>
+ <PatternLayout>
+ <Pattern>%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} -
%msg%n</Pattern>
+ </PatternLayout>
+ <Policies>
+ <TimeBasedTriggeringPolicy>
+ <interval>1</interval>
+ <modulate>true</modulate>
+ </TimeBasedTriggeringPolicy>
+ <SizeBasedTriggeringPolicy>
+ <size>1 GB</size>
+ </SizeBasedTriggeringPolicy>
+ <CronTriggeringPolicy>
+ <schedule>0 0 0 * * ?</schedule>
+ </CronTriggeringPolicy>
+ </Policies>
+ <DefaultRolloverStrategy>
+ <Delete>
+ <basePath>${sys:pulsar.function.log.dir}</basePath>
+ <maxDepth>2</maxDepth>
+ <IfFileName>
+ <glob>*/${sys:pulsar.function.log.file}*log.gz</glob>
+ </IfFileName>
+ <IfLastModified>
+ <age>30d</age>
+ </IfLastModified>
+ </Delete>
+ </DefaultRolloverStrategy>
+ </RollingFile>
+ <RollingRandomAccessFile>
+ <name>BkRollingFile</name>
+
<fileName>${sys:pulsar.function.log.dir}/${sys:pulsar.function.log.file}.bk</fileName>
+
<filePattern>${sys:pulsar.function.log.dir}/${sys:pulsar.function.log.file}.bk-%d{MM-dd-yyyy}-%i.log.gz</filePattern>
+ <immediateFlush>true</immediateFlush>
+ <PatternLayout>
+ <Pattern>%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} -
%msg%n</Pattern>
+ </PatternLayout>
+ <Policies>
+ <TimeBasedTriggeringPolicy>
+ <interval>1</interval>
+ <modulate>true</modulate>
+ </TimeBasedTriggeringPolicy>
+ <SizeBasedTriggeringPolicy>
+ <size>1 GB</size>
+ </SizeBasedTriggeringPolicy>
+ <CronTriggeringPolicy>
+ <schedule>0 0 0 * * ?</schedule>
+ </CronTriggeringPolicy>
+ </Policies>
+ <DefaultRolloverStrategy>
+ <Delete>
+ <basePath>${sys:pulsar.function.log.dir}</basePath>
+ <maxDepth>2</maxDepth>
+ <IfFileName>
+
<glob>*/${sys:pulsar.function.log.file}.bk*log.gz</glob>
+ </IfFileName>
+ <IfLastModified>
+ <age>30d</age>
+ </IfLastModified>
+ </Delete>
+ </DefaultRolloverStrategy>
+ </RollingRandomAccessFile>
+ </Appenders>
+ <Loggers>
+ <Logger>
+
<name>org.apache.pulsar.functions.runtime.shaded.org.apache.bookkeeper</name>
+ <level>${sys:bk.log.level}</level>
+ <additivity>false</additivity>
+ <AppenderRef>
+ <ref>BkRollingFile</ref>
+ </AppenderRef>
+ </Logger>
+ <Root>
+ <level>${sys:pulsar.log.level}</level>
+ <AppenderRef>
+ <ref>${sys:pulsar.log.appender}</ref>
+ <level>${sys:pulsar.log.level}</level>
+ </AppenderRef>
+ </Root>
+ </Loggers>
+</Configuration>
+```
+
+The properties set like:
+```xml
+ <Property>
+ <name>pulsar.log.level</name>
+ <value>debug</value>
+ </Property>
+```
+will propagate to places where they're referenced, such as:
Review comment:
Good feedback. Thanks!
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
[email protected]
