com.stackify.log.log4j12.StackifyLogAppender Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of stackify-log-log4j12 Show documentation
Stackify Log Appender for Log4j
There is a newer version: 4.0.2
/*
 * Copyright 2014 Stackify
 *
 * Licensed 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 com.stackify.log.log4j12;

import org.apache.log4j.spi.LoggingEvent;

import com.stackify.api.common.ApiClients;
import com.stackify.api.common.ApiConfiguration;
import com.stackify.api.common.ApiConfigurations;
import com.stackify.api.common.log.LogAppender;

/**
 * Log4j 1.2 logger appender for sending logs to Stackify.
 * 
 * 
 * Example appender configuration (*.properties file):
 * 
 * {@code
 * log4j.appender.STACKIFY=com.stackify.log.log4j12.StackifyLogAppender
 * log4j.appender.STACKIFY.apiKey=YOUR_API_KEY
 * log4j.appender.STACKIFY.application=YOUR_APPLICATION_NAME
 * log4j.appender.STACKIFY.environment=YOUR_ENVIRONMENT
 * }
 * 
 * 
 * 
 * Example appender configuration (*.xml file):
 * 
 * {@code
 * 
 *     
 *     
 *     
 * 
 * }
 * 
 *
 * 
 * Be sure to shutdown Log4j to flush this appender of any logs and shutdown the background thread:
 * 
 * LogManager.shutdown();
 * 
 *
 * @author Eric Martin
 */
public class StackifyLogAppender extends NonReentrantAppender {
		
	/**
	 * API URL (Appender configuration parameter)
	 */
	private String apiUrl = "https://api.stackify.com";
	
	/**
	 * API Key (Appender configuration parameter)
	 */
	private String apiKey = null;
	
	/**
	 * Application name (Appender configuration parameter)
	 */
	private String application = null;
	
	/**
	 * Environment (Appender configuration parameter)
	 */
	private String environment = null;
		
	/**
	 * Generic log appender
	 */
	private LogAppender logAppender;
	
	/**
	 * @return the apiUrl
	 */
	public String getApiUrl() {
		return apiUrl;
	}

	/**
	 * @param apiUrl the apiUrl to set
	 */
	public void setApiUrl(String apiUrl) {
		this.apiUrl = apiUrl;
	}

	/**
	 * @return the apiKey
	 */
	public String getApiKey() {
		return apiKey;
	}

	/**
	 * @param apiKey the apiKey to set
	 */
	public void setApiKey(String apiKey) {
		this.apiKey = apiKey;
	}

	/**
	 * @return the application
	 */
	public String getApplication() {
		return application;
	}

	/**
	 * @param application the application to set
	 */
	public void setApplication(String application) {
		this.application = application;
	}

	/**
	 * @return the environment
	 */
	public String getEnvironment() {
		return environment;
	}

	/**
	 * @param environment the environment to set
	 */
	public void setEnvironment(String environment) {
		this.environment = environment;
	}
	
	/**
	 * @see org.apache.log4j.AppenderSkeleton#activateOptions()
	 */
	@Override
	public void activateOptions() {
		super.activateOptions();
		
		// build the api config
		
		ApiConfiguration apiConfig = ApiConfigurations.fromPropertiesWithOverrides(apiUrl, apiKey, application, environment);
		
		// get the client project name with version

		String clientName = ApiClients.getApiClient(StackifyLogAppender.class, "/stackify-log-log4j12.properties", "stackify-log-log4j12");

		// build the log appender
		
		try {
			this.logAppender = new LogAppender(clientName, new LoggingEventAdapter(apiConfig.getEnvDetail()));
			this.logAppender.activate(apiConfig);
		} catch (Exception e) {
			errorHandler.error("Exception starting the Stackify_LogBackgroundService", e, 0);
		}
	}
	
	/**
	 * @see com.stackify.log.log4j12.NonReentrantAppender#subAppend(org.apache.log4j.spi.LoggingEvent)
	 */
	@Override
	protected void subAppend(final LoggingEvent event) {
		try {
			this.logAppender.append(event);
		} catch (Exception e) {
			errorHandler.error("Exception appending event to Stackify Log Appender", e, 0);
		}
	}
	
	/**
	 * @see org.apache.log4j.Appender#close()
	 */
	@Override
	public void close() {
		try {
			this.logAppender.close();
		} catch (Exception e) {
			errorHandler.error("Exception closing Stackify Log Appender", e, 0);
		}
	}

	/**
	 * @see org.apache.log4j.Appender#requiresLayout()
	 */
	@Override
	public boolean requiresLayout() {
		return false;
	}	
}