blob: 728fb85389d614364f38347d64a7abfd4768d045 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span>/*<a name="line.1"></a>
<span class="sourceLineNo">002</span> * Licensed to the Apache Software Foundation (ASF) under one or more<a name="line.2"></a>
<span class="sourceLineNo">003</span> * contributor license agreements. See the NOTICE file distributed with<a name="line.3"></a>
<span class="sourceLineNo">004</span> * this work for additional information regarding copyright ownership.<a name="line.4"></a>
<span class="sourceLineNo">005</span> * The ASF licenses this file to You under the Apache license, Version 2.0<a name="line.5"></a>
<span class="sourceLineNo">006</span> * (the "License"); you may not use this file except in compliance with<a name="line.6"></a>
<span class="sourceLineNo">007</span> * the License. You may obtain a copy of the License at<a name="line.7"></a>
<span class="sourceLineNo">008</span> *<a name="line.8"></a>
<span class="sourceLineNo">009</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.9"></a>
<span class="sourceLineNo">010</span> *<a name="line.10"></a>
<span class="sourceLineNo">011</span> * Unless required by applicable law or agreed to in writing, software<a name="line.11"></a>
<span class="sourceLineNo">012</span> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.12"></a>
<span class="sourceLineNo">013</span> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.13"></a>
<span class="sourceLineNo">014</span> * See the license for the specific language governing permissions and<a name="line.14"></a>
<span class="sourceLineNo">015</span> * limitations under the license.<a name="line.15"></a>
<span class="sourceLineNo">016</span> */<a name="line.16"></a>
<span class="sourceLineNo">017</span>package org.apache.logging.log4j.cassandra;<a name="line.17"></a>
<span class="sourceLineNo">018</span><a name="line.18"></a>
<span class="sourceLineNo">019</span>import com.datastax.driver.core.BatchStatement;<a name="line.19"></a>
<span class="sourceLineNo">020</span>import org.apache.logging.log4j.core.Core;<a name="line.20"></a>
<span class="sourceLineNo">021</span>import org.apache.logging.log4j.core.Filter;<a name="line.21"></a>
<span class="sourceLineNo">022</span>import org.apache.logging.log4j.core.appender.AbstractAppender;<a name="line.22"></a>
<span class="sourceLineNo">023</span>import org.apache.logging.log4j.core.appender.db.AbstractDatabaseAppender;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import org.apache.logging.log4j.core.appender.db.ColumnMapping;<a name="line.24"></a>
<span class="sourceLineNo">025</span>import org.apache.logging.log4j.core.config.Property;<a name="line.25"></a>
<span class="sourceLineNo">026</span>import org.apache.logging.log4j.core.config.plugins.Plugin;<a name="line.26"></a>
<span class="sourceLineNo">027</span>import org.apache.logging.log4j.core.config.plugins.PluginBuilderAttribute;<a name="line.27"></a>
<span class="sourceLineNo">028</span>import org.apache.logging.log4j.core.config.plugins.PluginBuilderFactory;<a name="line.28"></a>
<span class="sourceLineNo">029</span>import org.apache.logging.log4j.core.config.plugins.PluginElement;<a name="line.29"></a>
<span class="sourceLineNo">030</span>import org.apache.logging.log4j.core.config.plugins.validation.constraints.Required;<a name="line.30"></a>
<span class="sourceLineNo">031</span>import org.apache.logging.log4j.core.net.SocketAddress;<a name="line.31"></a>
<span class="sourceLineNo">032</span>import org.apache.logging.log4j.core.util.Clock;<a name="line.32"></a>
<span class="sourceLineNo">033</span><a name="line.33"></a>
<span class="sourceLineNo">034</span>/**<a name="line.34"></a>
<span class="sourceLineNo">035</span> * Appender plugin that uses a Cassandra database.<a name="line.35"></a>
<span class="sourceLineNo">036</span> *<a name="line.36"></a>
<span class="sourceLineNo">037</span> * @see SocketAddress<a name="line.37"></a>
<span class="sourceLineNo">038</span> * @see ColumnMapping<a name="line.38"></a>
<span class="sourceLineNo">039</span> */<a name="line.39"></a>
<span class="sourceLineNo">040</span>@Plugin(name = "Cassandra", category = Core.CATEGORY_NAME, elementType = CassandraAppender.ELEMENT_TYPE, printObject = true)<a name="line.40"></a>
<span class="sourceLineNo">041</span>public class CassandraAppender extends AbstractDatabaseAppender&lt;CassandraManager&gt; {<a name="line.41"></a>
<span class="sourceLineNo">042</span><a name="line.42"></a>
<span class="sourceLineNo">043</span> private CassandraAppender(final String name, final Filter filter, final boolean ignoreExceptions,<a name="line.43"></a>
<span class="sourceLineNo">044</span> final Property[] properties, final CassandraManager manager) {<a name="line.44"></a>
<span class="sourceLineNo">045</span> super(name, filter, null, ignoreExceptions, properties, manager);<a name="line.45"></a>
<span class="sourceLineNo">046</span> }<a name="line.46"></a>
<span class="sourceLineNo">047</span><a name="line.47"></a>
<span class="sourceLineNo">048</span> @PluginBuilderFactory<a name="line.48"></a>
<span class="sourceLineNo">049</span> public static &lt;B extends Builder&lt;B&gt;&gt; B newBuilder() {<a name="line.49"></a>
<span class="sourceLineNo">050</span> return new Builder&lt;B&gt;().asBuilder();<a name="line.50"></a>
<span class="sourceLineNo">051</span> }<a name="line.51"></a>
<span class="sourceLineNo">052</span><a name="line.52"></a>
<span class="sourceLineNo">053</span> public static class Builder&lt;B extends Builder&lt;B&gt;&gt; extends AbstractAppender.Builder&lt;B&gt;<a name="line.53"></a>
<span class="sourceLineNo">054</span> implements org.apache.logging.log4j.core.util.Builder&lt;CassandraAppender&gt; {<a name="line.54"></a>
<span class="sourceLineNo">055</span><a name="line.55"></a>
<span class="sourceLineNo">056</span> /**<a name="line.56"></a>
<span class="sourceLineNo">057</span> * List of Cassandra node contact points. Addresses without a port (or port set to 0) will use the default<a name="line.57"></a>
<span class="sourceLineNo">058</span> * Cassandra port (9042).<a name="line.58"></a>
<span class="sourceLineNo">059</span> */<a name="line.59"></a>
<span class="sourceLineNo">060</span> @PluginElement("ContactPoints")<a name="line.60"></a>
<span class="sourceLineNo">061</span> @Required(message = "No Cassandra servers provided")<a name="line.61"></a>
<span class="sourceLineNo">062</span> private SocketAddress[] contactPoints = new SocketAddress[]{SocketAddress.getLoopback()};<a name="line.62"></a>
<span class="sourceLineNo">063</span><a name="line.63"></a>
<span class="sourceLineNo">064</span> /**<a name="line.64"></a>
<span class="sourceLineNo">065</span> * List of column mappings to convert a LogEvent into a database row.<a name="line.65"></a>
<span class="sourceLineNo">066</span> */<a name="line.66"></a>
<span class="sourceLineNo">067</span> @PluginElement("Columns")<a name="line.67"></a>
<span class="sourceLineNo">068</span> @Required(message = "No Cassandra columns provided")<a name="line.68"></a>
<span class="sourceLineNo">069</span> private ColumnMapping[] columns;<a name="line.69"></a>
<span class="sourceLineNo">070</span><a name="line.70"></a>
<span class="sourceLineNo">071</span> @PluginBuilderAttribute<a name="line.71"></a>
<span class="sourceLineNo">072</span> private boolean useTls;<a name="line.72"></a>
<span class="sourceLineNo">073</span><a name="line.73"></a>
<span class="sourceLineNo">074</span> @PluginBuilderAttribute<a name="line.74"></a>
<span class="sourceLineNo">075</span> @Required(message = "No cluster name provided")<a name="line.75"></a>
<span class="sourceLineNo">076</span> private String clusterName;<a name="line.76"></a>
<span class="sourceLineNo">077</span><a name="line.77"></a>
<span class="sourceLineNo">078</span> @PluginBuilderAttribute<a name="line.78"></a>
<span class="sourceLineNo">079</span> @Required(message = "No keyspace provided")<a name="line.79"></a>
<span class="sourceLineNo">080</span> private String keyspace;<a name="line.80"></a>
<span class="sourceLineNo">081</span><a name="line.81"></a>
<span class="sourceLineNo">082</span> @PluginBuilderAttribute<a name="line.82"></a>
<span class="sourceLineNo">083</span> @Required(message = "No table name provided")<a name="line.83"></a>
<span class="sourceLineNo">084</span> private String table;<a name="line.84"></a>
<span class="sourceLineNo">085</span><a name="line.85"></a>
<span class="sourceLineNo">086</span> @PluginBuilderAttribute<a name="line.86"></a>
<span class="sourceLineNo">087</span> private String username;<a name="line.87"></a>
<span class="sourceLineNo">088</span><a name="line.88"></a>
<span class="sourceLineNo">089</span> @PluginBuilderAttribute(sensitive = true)<a name="line.89"></a>
<span class="sourceLineNo">090</span> private String password;<a name="line.90"></a>
<span class="sourceLineNo">091</span><a name="line.91"></a>
<span class="sourceLineNo">092</span> /**<a name="line.92"></a>
<span class="sourceLineNo">093</span> * Override the default TimestampGenerator with one based on the configured {@link Clock}.<a name="line.93"></a>
<span class="sourceLineNo">094</span> */<a name="line.94"></a>
<span class="sourceLineNo">095</span> @PluginBuilderAttribute<a name="line.95"></a>
<span class="sourceLineNo">096</span> private boolean useClockForTimestampGenerator;<a name="line.96"></a>
<span class="sourceLineNo">097</span><a name="line.97"></a>
<span class="sourceLineNo">098</span> /**<a name="line.98"></a>
<span class="sourceLineNo">099</span> * Number of LogEvents to buffer before writing. Can be used with or without batch statements.<a name="line.99"></a>
<span class="sourceLineNo">100</span> */<a name="line.100"></a>
<span class="sourceLineNo">101</span> @PluginBuilderAttribute<a name="line.101"></a>
<span class="sourceLineNo">102</span> private int bufferSize;<a name="line.102"></a>
<span class="sourceLineNo">103</span><a name="line.103"></a>
<span class="sourceLineNo">104</span> /**<a name="line.104"></a>
<span class="sourceLineNo">105</span> * Whether or not to use batch statements when inserting records.<a name="line.105"></a>
<span class="sourceLineNo">106</span> */<a name="line.106"></a>
<span class="sourceLineNo">107</span> @PluginBuilderAttribute<a name="line.107"></a>
<span class="sourceLineNo">108</span> private boolean batched;<a name="line.108"></a>
<span class="sourceLineNo">109</span><a name="line.109"></a>
<span class="sourceLineNo">110</span> /**<a name="line.110"></a>
<span class="sourceLineNo">111</span> * If batch statements are enabled, use this type of batch statement.<a name="line.111"></a>
<span class="sourceLineNo">112</span> */<a name="line.112"></a>
<span class="sourceLineNo">113</span> @PluginBuilderAttribute<a name="line.113"></a>
<span class="sourceLineNo">114</span> private BatchStatement.Type batchType = BatchStatement.Type.LOGGED;<a name="line.114"></a>
<span class="sourceLineNo">115</span><a name="line.115"></a>
<span class="sourceLineNo">116</span> public B setContactPoints(final SocketAddress... contactPoints) {<a name="line.116"></a>
<span class="sourceLineNo">117</span> this.contactPoints = contactPoints;<a name="line.117"></a>
<span class="sourceLineNo">118</span> return asBuilder();<a name="line.118"></a>
<span class="sourceLineNo">119</span> }<a name="line.119"></a>
<span class="sourceLineNo">120</span><a name="line.120"></a>
<span class="sourceLineNo">121</span> public B setColumns(final ColumnMapping... columns) {<a name="line.121"></a>
<span class="sourceLineNo">122</span> this.columns = columns;<a name="line.122"></a>
<span class="sourceLineNo">123</span> return asBuilder();<a name="line.123"></a>
<span class="sourceLineNo">124</span> }<a name="line.124"></a>
<span class="sourceLineNo">125</span><a name="line.125"></a>
<span class="sourceLineNo">126</span> public B setUseTls(final boolean useTls) {<a name="line.126"></a>
<span class="sourceLineNo">127</span> this.useTls = useTls;<a name="line.127"></a>
<span class="sourceLineNo">128</span> return asBuilder();<a name="line.128"></a>
<span class="sourceLineNo">129</span> }<a name="line.129"></a>
<span class="sourceLineNo">130</span><a name="line.130"></a>
<span class="sourceLineNo">131</span> public B setClusterName(final String clusterName) {<a name="line.131"></a>
<span class="sourceLineNo">132</span> this.clusterName = clusterName;<a name="line.132"></a>
<span class="sourceLineNo">133</span> return asBuilder();<a name="line.133"></a>
<span class="sourceLineNo">134</span> }<a name="line.134"></a>
<span class="sourceLineNo">135</span><a name="line.135"></a>
<span class="sourceLineNo">136</span> public B setKeyspace(final String keyspace) {<a name="line.136"></a>
<span class="sourceLineNo">137</span> this.keyspace = keyspace;<a name="line.137"></a>
<span class="sourceLineNo">138</span> return asBuilder();<a name="line.138"></a>
<span class="sourceLineNo">139</span> }<a name="line.139"></a>
<span class="sourceLineNo">140</span><a name="line.140"></a>
<span class="sourceLineNo">141</span> public B setTable(final String table) {<a name="line.141"></a>
<span class="sourceLineNo">142</span> this.table = table;<a name="line.142"></a>
<span class="sourceLineNo">143</span> return asBuilder();<a name="line.143"></a>
<span class="sourceLineNo">144</span> }<a name="line.144"></a>
<span class="sourceLineNo">145</span><a name="line.145"></a>
<span class="sourceLineNo">146</span> public B setUsername(final String username) {<a name="line.146"></a>
<span class="sourceLineNo">147</span> this.username = username;<a name="line.147"></a>
<span class="sourceLineNo">148</span> return asBuilder();<a name="line.148"></a>
<span class="sourceLineNo">149</span> }<a name="line.149"></a>
<span class="sourceLineNo">150</span><a name="line.150"></a>
<span class="sourceLineNo">151</span> public B setPassword(final String password) {<a name="line.151"></a>
<span class="sourceLineNo">152</span> this.password = password;<a name="line.152"></a>
<span class="sourceLineNo">153</span> return asBuilder();<a name="line.153"></a>
<span class="sourceLineNo">154</span> }<a name="line.154"></a>
<span class="sourceLineNo">155</span><a name="line.155"></a>
<span class="sourceLineNo">156</span> public B setUseClockForTimestampGenerator(final boolean useClockForTimestampGenerator) {<a name="line.156"></a>
<span class="sourceLineNo">157</span> this.useClockForTimestampGenerator = useClockForTimestampGenerator;<a name="line.157"></a>
<span class="sourceLineNo">158</span> return asBuilder();<a name="line.158"></a>
<span class="sourceLineNo">159</span> }<a name="line.159"></a>
<span class="sourceLineNo">160</span><a name="line.160"></a>
<span class="sourceLineNo">161</span> public B setBufferSize(final int bufferSize) {<a name="line.161"></a>
<span class="sourceLineNo">162</span> this.bufferSize = bufferSize;<a name="line.162"></a>
<span class="sourceLineNo">163</span> return asBuilder();<a name="line.163"></a>
<span class="sourceLineNo">164</span> }<a name="line.164"></a>
<span class="sourceLineNo">165</span><a name="line.165"></a>
<span class="sourceLineNo">166</span> public B setBatched(final boolean batched) {<a name="line.166"></a>
<span class="sourceLineNo">167</span> this.batched = batched;<a name="line.167"></a>
<span class="sourceLineNo">168</span> return asBuilder();<a name="line.168"></a>
<span class="sourceLineNo">169</span> }<a name="line.169"></a>
<span class="sourceLineNo">170</span><a name="line.170"></a>
<span class="sourceLineNo">171</span> public B setBatchType(final BatchStatement.Type batchType) {<a name="line.171"></a>
<span class="sourceLineNo">172</span> this.batchType = batchType;<a name="line.172"></a>
<span class="sourceLineNo">173</span> return asBuilder();<a name="line.173"></a>
<span class="sourceLineNo">174</span> }<a name="line.174"></a>
<span class="sourceLineNo">175</span><a name="line.175"></a>
<span class="sourceLineNo">176</span> @Override<a name="line.176"></a>
<span class="sourceLineNo">177</span> public CassandraAppender build() {<a name="line.177"></a>
<span class="sourceLineNo">178</span> final CassandraManager manager = CassandraManager.getManager(getName(), contactPoints, columns, useTls,<a name="line.178"></a>
<span class="sourceLineNo">179</span> clusterName, keyspace, table, username, password, useClockForTimestampGenerator, bufferSize, batched,<a name="line.179"></a>
<span class="sourceLineNo">180</span> batchType);<a name="line.180"></a>
<span class="sourceLineNo">181</span> return new CassandraAppender(getName(), getFilter(), isIgnoreExceptions(), null, manager);<a name="line.181"></a>
<span class="sourceLineNo">182</span> }<a name="line.182"></a>
<span class="sourceLineNo">183</span><a name="line.183"></a>
<span class="sourceLineNo">184</span> }<a name="line.184"></a>
<span class="sourceLineNo">185</span><a name="line.185"></a>
<span class="sourceLineNo">186</span>}<a name="line.186"></a>
</pre>
</div>
</body>
</html>