Splunk
借助 Splunk 连接器,您可以对 Splunk 数据库执行插入、删除、更新和读取操作。
准备工作
在使用 Splunk 连接器之前,请先完成以下任务:
- 在您的 Google Cloud 项目中:
- 将 IAM 角色 roles/connectors.admin 授予该用户 配置连接器。
- 将以下 IAM 角色授予您要用其来使用连接器的服务账号:
roles/secretmanager.viewer
roles/secretmanager.secretAccessor
服务账号是一种特殊类型的 Google 账号,用于表示需要验证身份并获得授权以访问 Google API 数据的非人类用户。如果您没有服务账号,则必须创建一个服务账号。如需了解详情,请参阅创建服务账号。
- 启用以下服务:
secretmanager.googleapis.com
(Secret Manager API)connectors.googleapis.com
(Connectors API)
如需了解如何启用服务,请参阅启用服务。
如果之前没有为您的项目启用这些服务或权限,则在您配置连接器时,系统会提示您启用。
配置连接器
配置连接器时,您需要创建与数据源(即后端系统)的连接。一个连接需专用于一个数据源。这意味着,如果您有许多数据源,则必须为每个数据源创建单独的连接。如需创建连接,请执行以下步骤:
- 在 Cloud 控制台 中,进入 Integration Connectors > 连接页面,然后选择或创建一个 Google Cloud 项目。
- 点击 + 新建以打开创建连接页面。
- 在位置部分中,选择连接的位置。
- 区域:从下拉列表中选择一个位置。
如需查看所有受支持区域的列表,请参阅位置。
- 点击下一步。
- 区域:从下拉列表中选择一个位置。
- 在连接详情部分中,完成以下操作:
- 连接器:从可用连接器的下拉列表中选择 Splunk。
- 连接器版本:从可用版本的下拉列表中选择一个连接器版本。
- 在连接名称字段中,输入连接实例的名称。
连接名称必须符合以下条件:
- 连接名称可以使用字母、数字或连字符。
- 字母必须小写。
- 连接名称必须以字母开头,以字母或数字结尾。
- 连接名称不能超过 49 个字符。
- (可选)输入连接实例的说明。
- (可选)启用 Cloud Logging。
然后选择一个日志级别默认情况下,日志级别设置为
Error
。 - 服务账号:选择具有所需角色的服务账号。
- (可选)配置连接节点设置:
- 节点数下限:输入连接节点数下限。
- 节点数上限:输入连接节点数上限。
节点是处理事务的连接单元(或副本)。 连接处理越多事务就需要越多节点,相反,处理越少事务需要越少节点。 如需了解节点如何影响连接器价格,请参阅连接节点的价格。如果未输入任何值,则默认情况下,节点数下限设置为 2(以便提高可用性),节点数上限设置为 50。
- (可选)点击 + 添加标签,以键值对的形式向连接添加标签。
- 点击下一步。
- 在目标部分中,输入要连接到的远程主机(后端系统)的详细信息。
- 目的地类型:选择目的地类型。
- 从列表中选择主机地址,以指定目标的主机名或 IP 地址。
- 如果要与后端系统建立专用连接,请从列表中选择端点连接,然后从端点连接列表中选择所需的端点连接。
如果要与后端系统建立公共连接以提高安全性,您可以考虑为连接配置静态出站 IP 地址,然后将防火墙规则配置为仅将特定静态 IP 地址列入许可名单。
要输入其他目标,请点击 + 添加目标。
- 点击下一步。
- 目的地类型:选择目的地类型。
-
在身份验证部分中,输入身份验证详细信息。
- 选择身份验证类型,然后输入相关详细信息。
Splunk 连接支持以下身份验证类型:
- 用户名和密码(基本身份验证)
- AccessToken
- HTTPEventCollectorToken
- 点击下一步。
如需了解如何配置这些身份验证类型,请参阅配置身份验证。
- 选择身份验证类型,然后输入相关详细信息。
- 查看:查看您的连接和身份验证详细信息。
- 点击创建。
配置身份验证
根据您要使用的身份验证输入详细信息。
-
用户名和密码
- 用户名:用于连接的 Splunk 用户名。
- 密码:包含与 Splunk 用户名关联的密码的 Secret Manager Secret。
-
AccessToken - 使用此字段可执行基于令牌的身份验证,方法是使用
AccessToken
属性。 -
HTTPEventCollectorToken - 设置此属性以使用
HTTPEventCollectorToken
属性执行基于令牌的身份验证。
实体、操作和动作
所有集成连接器都会为所连接应用的对象提供抽象层。您只能通过此抽象访问应用的对象。抽象作为实体、操作和动作向您展示。
- 实体:实体可以被视为连接的应用或服务中的对象或属性集合。不同连接器的实体定义也会有所不同。例如,在数据库连接器中,表是实体;在文件服务器连接器中,文件夹是实体;在消息传递系统连接器中,队列是实体。
但可能的情况是,连接器不支持或不具有任何实体,在这种情况下,
Entities
列表将为空。 - 操作:操作是指您可以对实体执行的操作。您可以对实体执行以下任一操作:
从可用列表中选择一个实体,系统会生成该实体可用的操作列表。如需了解操作的详细说明,请参阅连接器任务的实体操作。但是,如果连接器不支持任何实体操作, 操作未在
Operations
列表中列出。 - 动作:动作是可通过连接器接口提供给集成的头等函数。动作可让您对一个或多个实体进行更改,并且动作因连接器而异。通常,操作有一些输入参数和一个输出
参数。但可能的情况是,连接器不支持任何动作,在这种情况下,
Actions
列表将为空。
系统限制
Splunk 连接器每个节点每秒可处理 5 笔事务,并会对超出此限制的所有事务进行节流。不过,此连接器可以处理的事务数量也取决于 Splunk 实例施加的限制。 默认情况下,集成连接器会为连接分配 2 个节点(以提高可用性)。
如需了解适用于集成连接器的限制,请参阅限制。
操作
本部分列出了该连接器支持的操作。要了解如何配置 操作,请参阅操作示例。
CreateHTTPEvent 操作
此操作允许您通过 HTTP 和 HTTPS 协议将数据和应用事件发送到 Splunk 部署。
CreateHTTPEvent 操作的输入参数
参数名称 | 数据类型 | 必需 | 说明 |
---|---|---|---|
EventContent | 字符串 | 是 | 表或视图的名称。 |
ContentType | 字符串 | 否 | 为 EventContent 输入指定的内容类型。支持的
值为 JSON 和 RAWTEXT 。 |
ChannelGUID | 整数 | 否 | 用于事件的频道的 GUID。如果 ContentType 为 RAWTEXT ,您必须指定此值。 |
CreateHTTPEvent 操作的输出参数
此操作会返回所创建事件的成功状态。
CreateIndex 操作
通过此操作,您可以创建索引。
CreateIndex 操作的输入参数
参数名称 | 数据类型 | 必需 | 说明 |
---|---|---|---|
MaxMetaEntries | 字符串 | 否 | 设置存储桶 .data 文件中的唯一行数上限,这可能有助于减少内存消耗。 |
FrozenTimePeriodInSecs | 字符串 | 否 | 索引数据滚动到冻结状态所需的秒数。默认为 188697600(6 年)。 |
HomePath | 字符串 | 否 | 包含索引的热存储分区和温存储分区的绝对路径。 |
MinRawFileSyncSecs | 字符串 | 否 | 为此参数指定一个整数(或 disable )。此参数用于设置 splunkd 在压缩日志分片时强制同步文件系统的频率。 |
ProcessTrackerServiceInterval | 字符串 | 否 | 指定索引器检查子操作系统状态的频率(以秒为单位) 启动进程,看看能否为排队的请求启动新进程。 如果设置为 0,编入索引工具会每秒检查一次子进程状态。 |
ServiceMetaPeriod | 字符串 | 否 | 定义元数据同步到磁盘的频率(以秒为单位)。 |
MaxHotSpanSecs | 字符串 | 否 | 热门或温门分桶的目标最长时间跨度(以秒为单位)的上限。 |
QuarantinePastSecs | 字符串 | 否 | 如果事件的时间戳 quarantinePastSecs 超过 >now ,就会被放入隔离区。 |
ColdToFrozenDir | 字符串 | 否 | 冻结归档的目标路径。用作 ColdToFrozenScript 的替代方案。 |
ColdPath | 字符串 | 否 | 包含索引的 Coldline 的绝对路径。路径必须可读写。 |
MaxHotIdleSecs | 字符串 | 否 | 热存储桶的最长生命周期(秒) |
WarmToColdScript | 字符串 | 否 | 在将数据从温备区移至冷备区时要运行的脚本的路径。 |
ColdToFrozenScript | 字符串 | 否 | 归档脚本的路径。 |
MaxHotBuckets | 字符串 | 否 | 每个索引中可以存在的热点存储桶的数量上限。 |
TstatsHomePath | 字符串 | 否 | 存储此索引的数据模型加速 TSIDX 数据的位置。 如果指定,则必须根据卷定义进行定义。路径必须可写入 |
RepFactor | 字符串 | 否 | 索引复制控制。此参数仅适用于集群中的对等节点。
|
MaxDataSize | 字符串 | 否 | 在触发预热之前,热数据库达到的最大大小(以 MB 为单位)。
指定 auto 或 auto_high_volume 会导致 Splunk
来自动调整此参数(推荐)。 |
MaxBloomBackfillBucketAge | 字符串 | 否 | 有效值:整数[m|s|h|d]。如果温存分桶或冷存分桶的保留期限超过指定时长,则不会创建或重新构建其 Bloom 过滤器。指定 0 表示永不重建 bloomfilter。 |
BlockSignSize | 字符串 | 否 | 用于控制构成块签名的事件数量。如果设为 0 已对此索引停用块签名。建议值为 100。 |
名称 | 字符串 | 是 | 要创建的索引的名称 |
MaxTotalDataSizeMB | 字符串 | 否 | 索引的大小上限(以 MB 为单位)。如果索引的大小超过上限,系统会冻结最早的数据。 |
MaxWarmDBCount | 字符串 | 否 | 温存储分区的数量上限。如果超出此数值,暖存储桶 最近时间值最低的节点被转为冷状态。 |
RawChunkSizeBytes | 字符串 | 否 | 索引的原始数据日志中各个原始 slice 的目标未压缩大小(以字节为单位)。0 不是有效值。如果指定 0,则 rawChunkSizeBytes 会设置为默认值。 |
DataType | 字符串 | 否 | 指定索引的类型 |
MaxConcurrentOptimizes | 字符串 | 否 | 可针对热存储桶运行的并发优化进程的数量。 |
ThrottleCheckPeriod | 字符串 | 否 | 定义 Splunk 检查索引节流条件的频率(以秒为单位)。 |
SyncMeta | 字符串 | 否 | 如果为 true,则在元数据文件更新时,系统会在关闭文件描述符之前调用同步操作。此功能可提高元数据文件的完整性,尤其是 操作系统崩溃或机器故障的提醒 |
RotatePeriodInSecs | 字符串 | 否 | 检查是否需要创建新的热分桶的频率(以秒为单位)。此外,检查是否有需要滚动/冷冻的温水/冷水桶的频率。 |
CreateIndex 操作的输出参数
此操作会返回 CreateIndex 操作的确认消息。
例如,关于如何配置 CreateIndex
操作,
请参阅操作示例。
CreateSavedSearch 操作
此操作可让您保存搜索记录
CreateSavedSearch 操作的输入参数
参数名称 | 数据类型 | 必需 | 说明 |
---|---|---|---|
IsVisible | 布尔值 | 是 | 指明此已保存的搜索是否显示在显示的已保存搜索列表中。 |
RealTimeSchedule | 布尔值 | 是 | 如果此值设为 1,则调度器会根据当前时间确定下一个调度搜索执行时间。如果此值设置为 0,则确定 基于上次搜索执行时间。 |
搜索 | 字符串 | 是 | 要保存的搜索查询 |
说明 | 字符串 | 否 | 此已保存搜索的说明 |
SchedulePriority | 字符串 | 是 | 指示特定搜索的安排优先级 |
CronSchedule | 字符串 | 是 | 执行此搜索的 Cron 时间表。例如,*/5 * * * * 会导致搜索每 5 分钟执行一次。 |
名称 | 字符串 | 是 | 搜索的名称 |
UserContext | 字符串 | 是 | 如果提供了用户上下文,系统会使用 servicesNS 节点
(/servicesNS/[UserContext]/search),否则默认为常规端点 /services 。 |
RunOnStartup | 布尔值 | 是 | 指示此搜索是否在启动时运行。如果未在启动时运行,则会在下次预定时间运行。 |
已停用 | 布尔值 | 否 | 指示此已保存搜索是否已停用。 |
IsScheduled | 布尔值 | 是 | 指示此搜索是否按计划运行。 |
CreateSavedSearch 操作的输出参数
此操作会返回 CreateSavedSearch 操作的确认消息。
如需了解如何配置 CreateSavedSearch
操作,请参阅操作示例。
UpdateSavedSearch 操作
通过此操作,您可以更新已保存的搜索。
UpdateSavedSearch 操作的输入参数
参数名称 | 数据类型 | 必需 | 说明 |
---|---|---|---|
IsVisible | 布尔值 | 是 | 指明此已保存的搜索是否显示在显示的已保存搜索列表中。 |
RealTimeSchedule | 布尔值 | 是 | 如果此值设为 1,则调度器会根据当前时间确定下一次调度搜索执行时间。如果此值设置为 0,则确定 上次搜索执行时间。 |
搜索 | 字符串 | 是 | 要保存的搜索查询 |
说明 | 字符串 | 否 | 此已保存搜索的说明 |
SchedulePriority | 字符串 | 是 | 指示特定搜索的安排优先级 |
CronSchedule | 字符串 | 是 | 用于执行此搜索的 cron 时间表。例如,*/5 * * * * 会引发 每 5 分钟执行一次。 |
名称 | 字符串 | 是 | 搜索的名称 |
UserContext | 字符串 | 是 | 如果提供了用户上下文,则使用 servicesNS 节点 (/servicesNS/[UserContext]/search);否则,默认使用通用端点 /services 。 |
RunOnStartup | 布尔值 | 是 | 指示此搜索是否在启动时运行。如果未在启动时运行,则会在下次预定时间运行。 |
已停用 | 布尔值 | 否 | 指示此已保存搜索是否已停用。 |
IsScheduled | 布尔值 | 是 | 指示此搜索是否按时间表运行。 |
UpdateSavedSearch 操作的输出参数
此操作会返回 UpdateSavedSearch 操作的确认消息。
例如,关于如何配置 UpdateSavedSearch
操作,
请参阅操作示例。
DeleteIndex 操作
通过此操作,您可以删除索引。
DeleteIndex 操作的输入参数
参数名称 | 数据类型 | 必需 | 说明 |
---|---|---|---|
名称 | 字符串 | 是 | 要删除的索引的名称。 |
DeleteIndex 操作的输出参数
此操作会返回 DeleteIndex 操作的确认消息
例如,关于如何配置 DeleteIndex
操作,
请参阅操作示例。
UpdateIndex 操作
通过此操作,您可以更新索引。
UpdateIndex 操作的输入参数
参数名称 | 数据类型 | 必需 | 说明 |
---|---|---|---|
MaxMetaEntries | 字符串 | 否 | 设置存储桶 .data 文件中的唯一行数上限,这可能有助于减少内存消耗。 |
FrozenTimePeriodInSecs | 字符串 | 否 | 索引数据滚动到冻结状态所需的秒数。默认为 188697600(6 年)。 |
HomePath | 字符串 | 否 | 包含索引的热存储分区和温存储分区的绝对路径。 |
MinRawFileSyncSecs | 字符串 | 否 | 请为此参数指定一个整数(或 disable )。此参数用于设置 splunkd 在压缩日志分片时强制同步文件系统的频率。 |
ProcessTrackerServiceInterval | 字符串 | 否 | 指定索引编制工具检查其启动的子操作系统进程状态的频率(以秒为单位),以确定是否可以为排队的请求启动新进程。如果设为 0, 索引器每秒检查一次子进程的状态。 |
ServiceMetaPeriod | 字符串 | 否 | 定义元数据同步到磁盘的频率(以秒为单位)。 |
MaxHotSpanSecs | 字符串 | 否 | 热门或温门分桶的目标最长时间跨度(以秒为单位)的上限。 |
QuarantinePastSecs | 字符串 | 否 | 如果事件的时间戳 quarantinePastSecs 超过 now ,就会被放入隔离区。 |
ColdToFrozenDir | 字符串 | 否 | 冻结归档的目标路径。用作 ColdToFrozenScript 的替代方案。 |
ColdPath | 字符串 | 否 | 包含索引的 Coldline 的绝对路径。路径必须可读写。 |
MaxHotIdleSecs | 字符串 | 否 | 热存储桶的最长寿命(以秒为单位)。 |
WarmToColdScript | 字符串 | 否 | 在将数据从温备区移至冷备区时要运行的脚本的路径。 |
ColdToFrozenScript | 字符串 | 否 | 归档脚本的路径。 |
MaxHotBuckets | 字符串 | 否 | 每个索引中可以存在的热点存储桶的数量上限。 |
TstatsHomePath | 字符串 | 否 | 用于存储此索引的数据模型加速 TSIDX 数据的位置。如果已指定, 必须根据卷定义进行定义。路径必须可写入 |
RepFactor | 字符串 | 否 | 索引复制控制。此参数仅适用于集群中的对等节点。
|
MaxDataSize | 字符串 | 否 | 热数据库在触发滚动到温数据库之前可以达到的大小上限(以兆字节为单位)。
指定 auto 或 auto_high_volume 会使 Splunk 自动调整此参数(推荐)。 |
MaxBloomBackfillBucketAge | 字符串 | 否 | 有效值为:integer[m|s|h|d](如果温存储桶或冷存储桶的存在时间超过指定存在时间), 请勿创建或重建其 bloomfilter。指定 0 表示永不重建 bloomfilter。 |
BlockSignSize | 字符串 | 否 | 控制块签名块包含的事件数量。如果设为 0,则屏蔽 已对此索引停用签名。建议值为 100。 |
名称 | 字符串 | 是 | 要创建的索引的名称 |
MaxTotalDataSizeMB | 字符串 | 是 | 索引的大小上限(以 MB 为单位)。如果索引的大小超过上限,系统会冻结最早的数据。 |
MaxWarmDBCount | 字符串 | 否 | 温存储分区的数量上限。如果超出此数值,暖存储桶 最近时间值最低的节点被转为冷状态。 |
RawChunkSizeBytes | 字符串 | 否 | 索引的原始数据日志中各个原始 slice 的目标未压缩大小(以字节为单位)。 0 不是有效值。如果指定 0,则 rawChunkSizeBytes 会设为默认值。 |
DataType | 字符串 | 否 | 指定索引的类型 |
MaxConcurrentOptimizes | 字符串 | 否 | 可针对热存储桶运行的并发优化进程的数量。 |
ThrottleCheckPeriod | 字符串 | 否 | 定义 Splunk 检查索引节流条件的频率(以秒为单位)。 |
SyncMeta | 字符串 | 否 | 如果为 true,则在元数据文件更新时,系统会在关闭文件描述符之前调用同步操作。此功能可提高元数据文件的完整性,尤其是在 操作系统崩溃或机器故障 |
RotatePeriodInSecs | 字符串 | 否 | 检查是否需要创建新的热存储桶的频率(以秒为单位)。此外, 检查是否有应滚动或冻结的温水桶或冷水桶的频率。 |
UpdateIndex 操作的输出参数
此操作返回 UpdateIndex 操作的确认消息。
如需了解如何配置 UpdateIndex
操作,请参阅操作示例。
操作示例
示例 - 创建 HTTP 事件
此示例会创建一个 HTTP 事件。
- 在
Configure connector task
对话框中,点击Actions
。 - 选择
CreateHTTPEvent
操作,然后点击完成。 - 在连接器任务的任务输入部分中,点击
connectorInputPayload
,然后在Default Value
字段中输入类似于以下内容的值:{ "EventContent": "Testing Task", "ContentType": "RAWTEXT", "ChannelGUID": "ContentType=RAWTEXT" }
如果操作成功,CreateHTTPEvent
任务的 connectorOutputPayload
响应参数的值将类似于以下内容:
[{ "Success": "Success" }]
示例 - 创建索引
本示例创建了一个索引。
- 在
Configure connector task
对话框中,点击Actions
。 - 选择
CreateIndex
操作,然后点击完成。 - 在连接器任务的任务输入部分中,点击
connectorInputPayload
,然后在Default Value
字段中输入类似于以下内容的值:{ "Name": "http_testing" }
如果操作成功,CreateIndex
任务的 connectorOutputPayload
响应参数的值将类似于以下内容:
[{ "AssureUTF8": null, "BlockSignSize": null, "BlockSignatureDatabase": null, "BucketRebuildMemoryHint": null, "ColdPath": null, "FrozenTimePeriodInSecs": null, "HomePath": null, "HomePathExpanded": null, "IndexThreads": null, "IsInternal": null, "MaxConcurrentOptimizes": null, "MaxDataSize": null, "MaxHotBuckets": null, "SuppressBannerList": null, "Sync": null, "SyncMeta": null, "ThawedPath": null, "ThawedPathExpanded": null, "TstatsHomePath": null, "WarmToColdScript": null, }]
示例 - 创建已保存的搜索
此示例创建了一个已保存的搜索。
- 在
Configure connector task
对话框中,点击Actions
。 - 选择
CreateSavedSearch
操作,然后点击完成。 - 在连接器任务的任务输入部分,点击
connectorInputPayload
,然后在Default Value
字段:{ "Name": "test_created_g", "Search": "index=\"http_testing\"", "CronSchedule": "*/1 * * * *", "IsVisible": true, "RealTimeSchedule": true, "RunOnStartup": true, "IsScheduled": true, "SchedulePriority": "highest", "UserContext": "nobody" }
如果操作成功,CreateSavedSearch
任务的 connectorOutputPayload
响应参数的值将类似于以下内容:
[{ "Success": true, "Message": null }]
示例 - 更新已保存的搜索
本示例更新了一个已保存的搜索。
- 在
Configure connector task
对话框中,点击Actions
。 - 选择
UpdateSavedSearch
操作,然后点击完成。 - 在连接器任务的任务输入部分,点击
connectorInputPayload
,然后在Default Value
字段:{ "Name": "test_created_g", "Search": "index=\"december_test_data\"", "CronSchedule": "*/1 * * * *", "IsVisible": true, "RealTimeSchedule": true, "RunOnStartup": true, "IsScheduled": true, "SchedulePriority": "highest" }
如果操作成功,UpdateSavedSearch
任务的 connectorOutputPayload
响应参数的值将类似于以下内容:
[{ "Success": true, "Message": null }]
示例 - 删除索引
此示例将删除一个索引。
- 在
Configure connector task
对话框中,点击Actions
。 - 选择
DeleteIndex
操作,然后点击完成。 - 在连接器任务的任务输入部分中,点击
connectorInputPayload
,然后在Default Value
字段中输入类似于以下内容的值:{ "Name": "g_http_testing" }
如果操作成功,DeleteIndex
任务的 connectorOutputPayload
响应参数的值将类似于以下内容:
[{ "Success": true, "ErrorCode": null, "ErrorMessage": null }]
示例 - 更新索引
此示例更新索引。
- 在
Configure connector task
对话框中,点击Actions
。 - 选择
UpdateIndex
操作,然后点击完成。 - 在连接器任务的任务输入部分中,点击
connectorInputPayload
,然后在Default Value
字段中输入类似于以下内容的值:{ "MaxTotalDataSizeMB": "400000", "Name": "g_http_testing" }
如果操作成功,
UpdateIndex
任务的 connectorOutputPayload
响应
参数的值类似于以下内容:
[{ "AssureUTF8": false, "BlockSignSize": null, "BlockSignatureDatabase": null, "BucketRebuildMemoryHint": "auto", "ColdPath": "$SPLUNK_DB\\g_http_testing\\colddb", "ColdPathExpanded": "C:\\Program Files\\Splunk\\var\\lib\\splunk\\g_http_testing\\colddb", "ColdToFrozenDir": "", "ColdToFrozenScript": "", "CurrentDBSizeMB": 1.0, "DefaultDatabase": "main", "EnableOnlineBucketRepair": true, "EnableRealtimeSearch": true, "FrozenTimePeriodInSecs": 1.886976E8, "HomePath": "$SPLUNK_DB\\g_http_testing\\db", "HomePathExpanded": "C:\\Program Files\\Splunk\\var\\lib\\splunk\\g_http_testing\\db", "IndexThreads": "auto", "IsInternal": false, "LastInitTime": "2024-01-08 05:15:28.0", "MaxBloomBackfillBucketAge": "30d", "ThawedPath": "$SPLUNK_DB\\g_http_testing\\thaweddb", "ThawedPathExpanded": "C:\\Program Files\\Splunk\\var\\lib\\splunk\\g_http_testing\\thaweddb", "ThrottleCheckPeriod": 15.0, "TotalEventCount": 0.0, "TsidxDedupPostingsListMaxTermsLimit": 8388608.0, "TstatsHomePath": "volume:_splunk_summaries\\$_index_name\\datamodel_summary", "WarmToColdScript": "", "Success": true, "ErrorCode": null, "ErrorMessage": null }]
实体操作示例
本部分介绍如何在此连接器中执行某些实体操作。
示例 - 列出所有记录
此示例列出了 SearchJobs
实体中的所有记录。
- 在
Configure connector task
对话框中,点击Entities
。 - 从
Entity
列表中选择SearchJobs
。 - 选择
List
操作,然后点击完成。 - 您还可以在连接器任务的任务输入部分中,通过指定过滤条件子句来过滤结果集。始终使用英文单引号 (') 指定过滤条件子句值。
示例 - 从实体获取记录
此示例会从 SearchJobs
实体中获取指定 ID 的记录。
- 在
Configure connector task
对话框中,点击Entities
。 - 从
Entity
列表中选择SearchJobs
。 - 选择
Get
操作,然后点击完成。 - 在连接器任务的任务输入部分,点击实体 ID,然后
然后在 Default Value 字段中输入
1698309163.1300
。其中,
1698309163.1300
是SearchJobs
实体中的唯一记录 ID。
示例 - 在实体中创建记录
此示例在 DataModels
实体中创建了一条记录。
- 在
Configure connector task
对话框中,点击Entities
。 - 从
Entity
列表中选择DataModels
。 - 选择
Create
操作,然后点击完成。 - 在连接器任务的任务输入部分中,点击
connectorInputPayload
,然后在Default Value
字段中输入类似于以下内容的值:{ "Id": "Test1", "Acceleration": "{\"enabled\":false,\"earliest_time\":\"\", \"max_time\":3600,\"backfill_time\":\"\",\"source_guid\":\"\", \"manual_rebuilds\":false,\"poll_buckets_until_maxtime\":false, \"max_concurrent\":3,\"allow_skew\":\"0\",\"schedule_priority\":\"default\" ,\"allow_old_summaries\":false,\"hunk.file_format\":\"\",\"hunk.dfs_block_size\":0, \"hunk.compression_codec\":\"\",\"workload_pool\":\"\"}" }
如果集成成功,连接器任务的
connectorOutputPayload
字段的值将类似于以下内容:[{ "Id": "Test1" }]
示例 - 从实体中删除记录
以下示例将删除 DataModels
实体中具有指定 ID 的记录。
- 在
Configure connector task
对话框中,点击Entities
。 - 从
Entity
列表中选择DataModels
。 - 选择
Delete
操作,然后点击完成。 - 在连接器任务的任务输入部分,点击 entityId 并
然后在 Default Value 字段中输入
Test1
。
示例 - 更新实体中的记录
此示例会更新 DataModels
实体中的记录。
- 在
Configure connector task
对话框中,点击Entities
。 - 从
Entity
列表中选择DataModels
。 - 选择
Update
操作,然后点击完成。 - 在连接器任务的任务输入部分中,点击
connectorInputPayload
,然后在Default Value
字段中输入类似于以下内容的值:{ "Acceleration": "{\"enabled\":true,\"earliest_time\":\"-3mon\", \"cron_schedule\":\"*/5 * * * *\",\"max_time\":60, \"backfill_time\":\"\",\"source_guid\":\"\",\"manual_rebuilds\":false, \"poll_buckets_until_maxtime\":false,\"max_concurrent\":3, \"allow_skew\":\"0\",\"schedule_priority\":\"default\", \"allow_old_summaries\":false,\"hunk.file_format\":\"\",\"hunk.dfs_block_size\":0, \"hunk.compression_codec\":\"\",\"workload_pool\":\"\"}" }
- 点击 entityId,然后在 Default Value 字段中输入
/servicesNS/nobody/search/datamodel/model/Testing
。如果集成成功,连接器任务的
connectorOutputPayload
字段的值将类似于以下内容:[{ "Id": "/servicesNS/nobody/search/datamodel/model/Testing" }]
使用 Terraform 创建连接
您可以使用 Terraform 资源以创建新连接。如需了解如何应用或移除 Terraform 配置,请参阅基本 Terraform 命令。
如需查看用于创建连接的 Terraform 模板示例,请参阅模板示例。
使用 Terraform 创建此连接时,您必须在 Terraform 配置文件中设置以下变量:
参数名称 | 数据类型 | 必需 | 说明 |
---|---|---|---|
详细程度 | STRING | 错误 | 连接的详细程度级别,介于 1 到 5 之间。较高的详尽级别将记录所有通信详情(请求、响应和 SSL 证书)。 |
proxy_enabled | BOOLEAN | 错误 | 选中此复选框可为连接配置代理服务器。 |
proxy_auth_scheme | ENUM | 错误 | 用于向 ProxyServer 代理进行身份验证的身份验证类型。支持的值包括:BASIC、DIGEST、NONE |
proxy_user | STRING | 错误 | 用于向 ProxyServer 代理进行身份验证的用户名。 |
proxy_password | SECRET | 错误 | 用于向 ProxyServer 代理进行身份验证的密码。 |
proxy_ssltype | ENUM | 错误 | 连接到 ProxyServer 代理时使用的 SSL 类型。支持的值包括:AUTO、ALWAYS、NEVER、TUNNEL |
在集成中使用 Splunk 连接
创建连接后,该连接将在 Apigee Integration 和 Application Integration 中可用。您可以使用连接 通过连接器任务在集成中进行集成。