首页
/ Splunk Java SDK 使用与技术文档

Splunk Java SDK 使用与技术文档

2024-12-23 15:22:29作者:董灵辛Dennis

一、安装指南

Splunk 安装

首先,您需要安装Splunk。如果没有安装,可以从Splunk官网下载。关于安装和运行Splunk以及系统要求,请参阅Splunk安装与运行指南。Splunk SDK for Java已与Splunk Enterprise 9.0和8.2版本进行了测试。

Splunk SDK for Java 安装

  • 下载Splunk SDK for Java,解压文件后构建SDK。
  • 或者,下载JAR文件并添加到您的项目中。

如果您想为SDK贡献代码,可以从GitHub克隆仓库。

Java 使用 Maven

您可以使用Apache Maven构建您的Splunk SDK for Java项目。通过更新项目中的pom.xml文件,它将检索所有必要的依赖项并无缝构建您的项目。

要添加Splunk SDK for Java的.JAR文件作为依赖项:

  1. 将存储库添加到项目的pom.xml文件中:
<repositories>
  ...
  <repository>
    <id>splunk-artifactory</id>
    <name>Splunk Releases</name>
    <url>http://splunk.jfrog.io/splunk/ext-releases-local</url>
  </repository>
</repositories>
  1. 将依赖项添加到pom.xml文件中:
<dependencies>
  ...
  <dependency>
    <groupId>com.splunk</groupId>
    <artifactId>splunk</artifactId>
    <version>1.9.5</version>
  </dependency>
</dependencies>

确保更新版本号以匹配您使用的Splunk SDK for Java版本。

注意:您也可以进行类似的更改以使用Gradle

二、项目的使用说明

构建SDK和文档

要构建SDK,请在splunk-sdk-java目录下打开命令提示符并输入:

mvn

或者

mvn package

此命令将构建所有.class.jar文件。如果您只想构建.class文件,请输入:

mvn compile

要从仓库中删除所有构建工件,请输入:

mvn clean

要构建SDK文档,请在执行mvn package时自动生成,或者输入:

cd splunk
mvn javadoc:javadoc

使用示例

以下是使用Splunk SDK for Java的一些基本操作示例:

使用用户名和密码登录

import com.splunk.Service;
import com.splunk.ServiceArgs;

public class SplunkLogin {
    static Service service = null;
    public static void main(String args[]) {
        ServiceArgs loginArgs = new ServiceArgs();
        loginArgs.setPort(8089);
        loginArgs.setHost("localhost");
        loginArgs.setScheme("https");
        loginArgs.setUsername("USERNAME"); // 使用您的用户名
        loginArgs.setPassword("PASSWORD"); // 使用您的密码
        service = Service.connect(loginArgs);
    }
}

使用会话令牌登录

import com.splunk.Service;
import com.splunk.ServiceArgs;

public class SplunkLogin {
    static Service service = null;
    public static void main(String args[]) {
        ServiceArgs loginArgs = new ServiceArgs();
        loginArgs.setPort(8089);
        loginArgs.setHost("localhost");
        loginArgs.setScheme("https");
        loginArgs.setToken("1k_Ostpl6NBe4iVQ5d6I3Ohla_U5");
        service = Service.connect(loginArgs);
    }
}

使用认证令牌登录(推荐)

import com.splunk.Service;
import com.splunk.ServiceArgs;

public class SplunkLogin {
    static Service service = null;
    public static void main(String args[]) {
        ServiceArgs loginArgs = new ServiceArgs();
        loginArgs.setPort(8089);
        loginArgs.setHost("localhost");
        loginArgs.setScheme("https");
        loginArgs.setToken("Bearer 1k_Ostpl6NBe4iVQ5d6I3Ohla_U5");
        service = Service.connect(loginArgs);
    }
}

运行简单搜索

import com.splunk.Job;
import com.splunk.ResultsReader;
import com.splunk.ResultsReaderXml;
import com.splunk.Service;
import com.splunk.ServiceArgs;

public class SearchExample {
    static Service service = null;
    public static void main(String args[]) {
        ServiceArgs loginArgs = new ServiceArgs();
        loginArgs.setPort(8089);
        loginArgs.setHost("localhost");
        loginArgs.setScheme("https");
        loginArgs.setToken("Bearer 1k_Ostpl6NBe4iVQ5d6I3Ohla_U5");
        service = Service.connect(loginArgs);
        Job job = service.getJobs().create("search index=_internal | head 10");
        while (!job.isReady()) {
            try {
                Thread.sleep(500);
            } catch (Exception e) {
                // 处理异常
            }
        }
        try {
            ResultsReader reader = new ResultsReaderXml(job.getEvents());
            reader.forEach(event -> System.out.println(event.get("_raw")));
        } catch (Exception e) {
            // 处理异常
        }
    }
}

关于使用令牌进行身份验证的更多信息,请访问Splunk文档

三、项目API使用文档

Splunk SDK for Java的API使用文档可以通过构建项目时生成的javadoc获得,或者在Splunk开发者门户上查阅。

四、项目安装方式

请遵循以下步骤来安装Splunk SDK for Java:

  1. Splunk开发者门户下载Splunk SDK for Java。
  2. 解压下载的ZIP文件。
  3. 根据您的构建系统配置(如Maven或Gradle),将Splunk SDK for Java的JAR文件添加为项目依赖项。
  4. 使用上述提供的代码示例来开始使用Splunk SDK for Java。

确保您的项目中已正确设置所有必要的信息,如Splunk服务器的地址、端口、用户名、密码以及使用的协议。

登录后查看全文

项目优选

收起
leetcodeleetcode
🔥LeetCode solutions in any programming language | 多种编程语言实现 LeetCode、《剑指 Offer(第 2 版)》、《程序员面试金典(第 6 版)》题解
Java
51
15
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
535
406
openGauss-serveropenGauss-server
openGauss kernel ~ openGauss is an open source relational database management system
C++
63
145
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
120
207
cherry-studiocherry-studio
🍒 Cherry Studio 是一款支持多个 LLM 提供商的桌面客户端
TypeScript
397
37
Cangjie-ExamplesCangjie-Examples
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
297
1.03 K
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
98
251
HarmonyOS-ExamplesHarmonyOS-Examples
本仓将收集和展示仓颉鸿蒙应用示例代码,欢迎大家投稿,在仓颉鸿蒙社区展现你的妙趣设计!
Cangjie
358
342
CS-BooksCS-Books
🔥🔥超过1000本的计算机经典书籍、个人笔记资料以及本人在各平台发表文章中所涉及的资源等。书籍资源包括C/C++、Java、Python、Go语言、数据结构与算法、操作系统、后端架构、计算机系统知识、数据库、计算机网络、设计模式、前端、汇编以及校招社招各种面经~
50
5
金融AI编程实战金融AI编程实战
为非计算机科班出身 (例如财经类高校金融学院) 同学量身定制,新手友好,让学生以亲身实践开源开发的方式,学会使用计算机自动化自己的科研/创新工作。案例以量化投资为主线,涉及 Bash、Python、SQL、BI、AI 等全技术栈,培养面向未来的数智化人才 (如数据工程师、数据分析师、数据科学家、数据决策者、量化投资人)。
Jupyter Notebook
51
54