@kumologica/kumologica-contrib-splunk
Version:
Node that integrates with Splunk.
161 lines (144 loc) • 6.23 kB
HTML
<script type="text/javascript">
RED.nodes.registerType('splunk', {
category: 'logging',
color: '#03A91C',
defaults: {
name: { value: 'Splunk' },
// connection
splunkHost: { value: '',templateable: true , required: true },
splunkPort: { value: '8088',templateable: true , required: true },
hecToken: { value: '',templateable: true , required: true },
//metadata
metaHost: { value: '', templateable: true },
metaSource: { value: '', templateable: true },
metaSourceType: { value: '',templateable: true},
metaIndex: { value: '', templateable: true },
// payload
splunkLogData: { value: '',templateable: true },
level: { value: 'info', required: true },
consoleOutput: { value: false }
},
inputs: 1,
outputs: 1,
icon: 'kumo_splunk.png',
label: function() {
return this.name || 'Splunk';
}
});
</script>
<script type="text/x-kumologica" data-template-name="splunk">
<style scoped>
.hiddenAttrs {display:none;}
.visibleAttrs {display:block;}
</style>
<div class="kumo-window">
<!-- Display name -->
<div class="kumo-section">
<div class="kumo-row">
<label class="kumo-row-label" for="node-input-name">Display Name</label>
<input class="kumo-row-editable" type="text" id="node-input-name" placeholder="Node Name">
</div>
</div>
<!-- Splunk Connection Configuration -->
<div class="kumo-section-title">Connection</div>
<div class="kumo-section">
<div class="kumo-row">
<div class="kumo-row-with-margin">
<label class="kumo-row-label" for="node-input-splunkHost">Host</label>
<input class="kumo-row-editable" type="text" id="node-input-splunkHost" placeholder="Splunk Server Host">
</div>
</div>
<div class="kumo-row">
<div class="kumo-row-with-margin">
<label class="kumo-row-label" for="node-input-splunkPort">Port</label>
<input class="kumo-row-editable" type="text" id="node-input-splunkPort" placeholder="443">
</div>
</div>
<div class="kumo-row">
<div class="kumo-row-with-margin">
<label title="HEC Token" class="kumo-row-label" for="node-input-hecToken">Token</label>
<input class="kumo-row-editable" type="text" id="node-input-hecToken" placeholder="Splunk HTTP Event Collector Token"></input>
</div>
</div>
</div>
<div class="kumo-section-title">Event</div>
<div class="kumo-section">
<div class="kumo-row">
<div class="kumo-row-with-margin">
<label class="kumo-row-label" for="node-input-splunkLogData">Message</label>
<input class="kumo-row-editable" type="text" id="node-input-splunkLogData" placeholder="Data to log to Splunk"></input>
</div>
</div>
<div class="kumo-row">
<div class="kumo-row-with-margin">
<label class="kumo-row-label" for="node-input-level">Level</label>
<select class="kumo-row-editable" type="text" id="node-input-level">
<option value="debug">DEBUG</option>
<option value="info">INFO</option>
<option value="warn">WARN</option>
<option value="error">ERROR</option>
</select>
</div>
</div>
</div>
<!-- Splunk Security Configuration -->
<div class="kumo-section-title">Metadata</div>
<div class="kumo-section">
<div class="kumo-row">
<div class="kumo-row-with-margin">
<label class="kumo-row-label" for="node-input-metaSource">Source</label>
<input class="kumo-row-editable" type="text" id="node-input-metaSource"></input>
</div>
</div>
<div class="kumo-row">
<div class="kumo-row-with-margin">
<label class="kumo-row-label" for="node-input-metaSourceType">SourceType</label>
<input class="kumo-row-editable" type="text" id="node-input-metaSourceType"></input>
</div>
</div>
<div class="kumo-row">
<div class="kumo-row-with-margin">
<label class="kumo-row-label" for="node-input-metaHost">Host</label>
<input class="kumo-row-editable" type="text" id="node-input-metaHost"></input>
</div>
</div>
<div class="kumo-row">
<div class="kumo-row-with-margin">
<label class="kumo-row-label" for="node-input-metaIndex">Index</label>
<input class="kumo-row-editable" type="text" id="node-input-metaIndex"></input>
</div>
</div>
</div>
<!-- Extra Configuration -->
<div class="kumo-section-title">Extra</div>
<div class="kumo-section">
<div class="kumo-row">
<div class="kumo-row-with-margin">
<input style="width:20px; vertical-align:top; margin: 0px 5px 5px 0px;" type="checkbox" id="node-input-consoleOutput">
<label style="width: auto;" for="node-input-consoleOutput">Send copy of log to console</span>
</div>
</div>
</div>
</div>
</script>
<script type="text/x-kumologica" data-help-name="splunk">
<h4> Description </h4>
<p>Splunk node is the client for sending logs to Splunk cloud.</p>
<h4> Properties </h4>
<ul>
<li><i>Host</i> - (Required). Hostname of the Splunk platform to connect.</li>
<li><i>Port</i> - (Required). Port for associated with Splunk instance.</li>
<li><i>Message</i> - (Optional). Log message to be sent.</li>
<li><i>Splunk HEC Token</i> - (Required). HEC token Key for authenticating with the platform.</li>
</ul>
<p><i>Note : </i> The node just expects the Splunk HEC security token to connect to the Splunk HEC listener.</p>
<h4> Throws </h4>
<ul>
<li>SplunkConnectionError</li>
</ul>
<h4> Returns </h4>
Payload will not be overwrittten by this node.
None of the variables will be overwritten or enriched by this node.
<h4> More info </h4>
<a href="http://kumologica.com/">Kumologica Documentation</a>
</script>