splunk-library-javalogging - GitLite

KO | EN

gitlite — search

#python #hacktoberfest #react #typescript #android #machine-learning #deep-learning #linux #docker #windows #awesome #cli #security #openai

splunk-library-javalogging

(★ 140)

Splunk logging appenders for popular Java Logging frameworks

File Explorer

Download Latest Version (.zip)

- - pr_template.md
- - release.yml
  - test.yml
- uiDesigner.xml
- LICENSE-COMMONS
- LICENSE-GSON
- LICENSE-JUNIT
- LICENSE-LOG4J
- LICENSE-LOGBACK-EPL
- LICENSE-LOGBACK-GNU
- LICENSE-OKHTTP
- LICENSE-SLF4J
- test_specific.sh
.gitignore
bnd.bnd
CHANGELOG.md
CONTRIBUTING.md
CREDITS.md
docker-compose.yml
LICENSE
Makefile
pom.xml
README.md

# Installation Guide

1. Get the code

git clone https://github.com/splunk/splunk-library-javalogging

Downloads the entire project code from GitHub to your computer.

cd splunk-library-javalogging

Moves into the project folder you just downloaded.

2. Docker

Easy Recommended

Prerequisites

Git Needed to download the project code from GitHub.
Docker Desktop Needed to build and run containers. Install it and keep it running in the background.

docker compose up -d --build

Builds and starts all defined containers (server, database, etc.) at once, in the background.

✅ Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

3. Maven (Java)

Medium

Prerequisites

Git Needed to download the project code from GitHub.
JDK (Java) Required to build and run Java projects.
Maven The build tool used for the mvn command.

mvn clean install

Installs dependencies and builds the project using Maven.

✅ A BUILD SUCCESS message means it worked. The output is created under target/.

4. Make

Medium

Prerequisites

Git Needed to download the project code from GitHub.
Make Usually pre-installed on Linux/macOS. On Windows, install separately (e.g. via MSYS2 or WSL).

make

Compiles the code based on the generated build configuration to produce an executable.

✅ If it finishes without errors, it worked. Try running the generated executable directly.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Splunk Logging for Java

## Version 1.11.11

Splunk logging for Java enables you to log events to HTTP Event Collector or to a TCP input on a Splunk Enterprise instance within your Java applications. You can use three major Java logging frameworks: [Logback](http://logback.qos.ch), [Log4j 2](http://logging.apache.org/log4j/2.x/), and [java.util.logging](https://docs.oracle.com/javase/7/docs/api/java/util/logging/package-summary.html). Splunk logging for Java is also enabled for [Simple Logging Facade for Java (SLF4J)](http://www.slf4j.org).

Splunk logging for Java provides:

* Appender classes that package events into the proper format for the input type you're using (HTTP Event Collector or TCP).

* Handler classes that export the logging events.

* An optional error handler to catch failures for HTTP Event Collector events.

* Example configuration files for all three frameworks that show how to configure the frameworks to write to HTTP Event Collector or TCP ports.

* Support for batching events (sent to HTTP Event Collector only).</li>

### Requirements

Here's what you need to get going with Splunk logging for Java.

#### Splunk

If you haven't already installed Splunk, download it
[here](http://www.splunk.com/download). For more about installing and running
Splunk and system requirements, see [Installing & Running Splunk](http://dev.splunk.com/view/SP-CAAADRV). Splunk logging for Java is tested with Splunk Enterprise 8.0, 8.2, and 9.1.

#### Java

You'll need Java version 8 or higher, from [OpenJDK](https://openjdk.java.net) or [Oracle](https://www.oracle.com/technetwork/java).

#### Logging frameworks

If you're using the Log4j 2, Simple Logging Facade for Java (SLF4J), or Logback logging frameworks in conjunction with Splunk logging for Java there are additional compatibility requirements. For more about logging framework requirements, see [Enable logging to HEC](https://dev.splunk.com/enterprise/docs/devtools/java/logging-java/howtouseloggingjava/enableloghttpjava/) and [Enable logging to TCP inputs](https://dev.splunk.com/enterprise/docs/devtools/java/logging-java/howtouseloggingjava/enablelogtcpjava). These frameworks require:

* Log4j version 2.25.4
* SLF4J version 1.7.36
* Logback version 1.2.13

## Documentation and resources

* For more information about installing and using Splunk logging for Java, see
  [Overview of Splunk logging for Java](http://dev.splunk.com/goto/sdk-slj).

* For reference documentation, see the
  [Splunk logging for Java API reference](https://docs.splunk.com/DocumentationStatic/JavaLogging/1.8.0/index.html).

* For all things developer with Splunk, see the
  [Splunk Developer Portal](http://dev.splunk.com).

* For more about about Splunk in general, see
  [Splunk>Docs](http://docs.splunk.com/Documentation/Splunk).

## Dependency Management

The `splunk-library-javalogging` artifact can be accessed via Splunk's managed Maven repository.

### Apache Maven

First define the repository as follows

```xml
...
  <repositories>
    <repository>
        <id>splunk-artifactory</id>
        <name>Splunk Releases</name>
        <url>https://splunk.jfrog.io/splunk/ext-releases-local</url>
    </repository>
  </repositories>
...
```

... then reference the dependency as follows

```xml
...
  <dependencies>
    <dependency>
      <groupId>com.splunk.logging</groupId>
      <artifactId>splunk-library-javalogging</artifactId>
      <version>${latest.version}</version>
    </dependency>
    ...
  </dependencies>
...
```

The above can be adapted to suit Other dependency management implementations as necessary.

## License

Splunk logging for Java is licensed under the Apache License 2.0.

See the [LICENSE file](/license.md) for details.

## Contributions

[Get the Splunk Java Logging Framework from GitHub](https://github.com/splunk/splunk-library-javalogging)
and clone the resources to your computer. For example, use the following
command:

git clone https://github.com/splunk/splunk-library-javalogging.git

## Support

The Splunk logging for Java is community-supported.

1. You can find help through our community on [Splunk Answers](https://community.splunk.com/t5/tag/logging-library-java/tg-p) (use the "logging-library-java" tag to identify your questions).
2. File issues on [GitHub](https://github.com/splunk/splunk-library-javalogging/issues).