[
https://issues.apache.org/jira/browse/LOG4J2-2280?focusedWorklogId=305840&page=com.atlassian.jira.plugin.system.issuetabpanels:worklog-tabpanel#worklog-305840
]
ASF GitHub Bot logged work on LOG4J2-2280:
------------------------------------------
Author: ASF GitHub Bot
Created on: 03/Sep/19 20:03
Start Date: 03/Sep/19 20:03
Worklog Time Spent: 10m
Work Description: jvz commented on pull request #158: [LOG4J2-2280]
Introduce an Apache Pulsar log4j appender
URL: https://github.com/apache/logging-log4j2/pull/158#discussion_r320451657
##########
File path:
log4j-pulsar/src/main/java/org/apache/logging/log4j/pulsar/appender/PulsarAppender.java
##########
@@ -0,0 +1,211 @@
+/**
+ * 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.
+ */
+package org.apache.logging.log4j.pulsar.appender;
+
+import java.io.Serializable;
+import java.util.Objects;
+import java.util.concurrent.TimeUnit;
+import org.apache.logging.log4j.core.AbstractLifeCycle;
+import org.apache.logging.log4j.core.Appender;
+import org.apache.logging.log4j.core.Filter;
+import org.apache.logging.log4j.core.Layout;
+import org.apache.logging.log4j.core.LogEvent;
+import org.apache.logging.log4j.core.appender.AbstractAppender;
+import org.apache.logging.log4j.core.config.Node;
+import org.apache.logging.log4j.core.config.Property;
+import org.apache.logging.log4j.core.config.plugins.Plugin;
+import org.apache.logging.log4j.core.config.plugins.PluginAttribute;
+import org.apache.logging.log4j.core.config.plugins.PluginBuilderFactory;
+import org.apache.logging.log4j.core.config.plugins.PluginElement;
+import org.apache.logging.log4j.core.layout.SerializedLayout;
+
+/**
+ * The PulsarAppender logs events to an Apache Pulsar topic.
+ *
+ * <p>Each log event is sent as a Pulsar record.
+ */
+@Plugin(
+ name = "Pulsar",
+ category = Node.CATEGORY,
+ elementType = Appender.ELEMENT_TYPE,
+ printObject = true)
+public final class PulsarAppender extends AbstractAppender {
+
+ /**
+ * Builds PulsarAppender instances.
+ * @param <B> The type to build
+ */
+ public static class Builder<B extends Builder<B>> extends
AbstractAppender.Builder<B>
+ implements
org.apache.logging.log4j.core.util.Builder<PulsarAppender> {
+
+ @PluginAttribute("key")
+ private String key;
+
+ @PluginAttribute("topic")
+ private String topic;
+
+ @PluginAttribute("serviceUrl")
+ private String serviceUrl;
+
+ @PluginAttribute(value = "avoidRecursive", defaultBoolean = true)
+ private boolean avoidRecursive;
+
+ @PluginAttribute(value = "syncSend", defaultBoolean = false)
+ private boolean syncSend;
+
+ @PluginElement("Properties")
+ private Property[] properties;
+
+ @SuppressWarnings("resource")
+ @Override
+ public PulsarAppender build() {
+ final Layout<? extends Serializable> layout = getLayout();
+ if (layout == null) {
+ AbstractLifeCycle.LOGGER.error("No layout provided for
PulsarAppender");
+ return null;
+ }
+ PulsarManager manager = new PulsarManager(
+ getConfiguration().getLoggerContext(),
+ getName(),
+ serviceUrl,
+ topic,
+ syncSend,
+ properties,
+ key);
+ return new PulsarAppender(
+ getName(),
+ layout,
+ getFilter(),
+ isIgnoreExceptions(),
+ avoidRecursive,
+ manager);
+ }
+
+ public String getTopic() {
+ return topic;
+ }
+
+ public boolean isSyncSend() {
+ return syncSend;
+ }
+
+ public Property[] getProperties() {
+ return properties;
+ }
+
+ public B setTopic(final String topic) {
+ this.topic = topic;
+ return asBuilder();
+ }
+
+ public B setSyncSend(final boolean syncSend) {
+ this.syncSend = syncSend;
+ return asBuilder();
+ }
+
+ public B setProperties(final Property[] properties) {
+ this.properties = properties;
+ return asBuilder();
+ }
+ }
+
+ /**
+ * Creates a builder for a PulsarAppender.
+ * @return a builder for a PulsarAppender.
+ */
+ @PluginBuilderFactory
+ public static <B extends Builder<B>> B newBuilder() {
+ return new Builder<B>().asBuilder();
+ }
+
+ private final boolean avoidRecursive;
+ private final PulsarManager manager;
+
+ private PulsarAppender(
+ final String name,
+ final Layout<? extends Serializable> layout,
+ final Filter filter,
+ final boolean ignoreExceptions,
+ final boolean avoidRecursive,
+ final PulsarManager manager) {
+ super(name, filter, layout, ignoreExceptions);
+ this.avoidRecursive = avoidRecursive;
+ this.manager = Objects.requireNonNull(manager, "manager");
+ }
+
+ @Override
+ public void append(final LogEvent event) {
+ if (avoidRecursive
+ && event.getLoggerName() != null
+ && event.getLoggerName().startsWith("org.apache.pulsar")) {
+ LOGGER.warn("Recursive logging from [{}] for appender [{}].",
event.getLoggerName(), getName());
+ } else {
+ try {
+ tryAppend(event);
+ } catch (final Exception e) {
Review comment:
You can wrap this exception to rethrow. There's a standard appender option
to ignore exceptions which is enabled by default, so you have no need to
swallow it here.
----------------------------------------------------------------
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]
Issue Time Tracking
-------------------
Worklog Id: (was: 305840)
Time Spent: 20m (was: 10m)
> New appender for Apache Pulsar
> ------------------------------
>
> Key: LOG4J2-2280
> URL: https://issues.apache.org/jira/browse/LOG4J2-2280
> Project: Log4j 2
> Issue Type: New Feature
> Components: Appenders
> Reporter: Sijie Guo
> Priority: Major
> Time Spent: 20m
> Remaining Estimate: 0h
>
> It would be useful to have an Appender which sends log events to an[ Apache
> Pulsar|https://pulsar.incubator.apache.org/] topic.
--
This message was sent by Atlassian Jira
(v8.3.2#803003)
