支援終止通知：2026 年 10 月 7 日 AWS 將停止 的支援 AWS IoT Greengrass Version 1。2026 年 10 月 7 日之後，您將無法再存取 AWS IoT Greengrass V1 資源。如需詳細資訊，請造訪[從 遷移 AWS IoT Greengrass Version 1](https://docs.aws.amazon.com/greengrass/v2/developerguide/migrate-from-v1.html)。

本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。

# Splunk 整合連接器
<a name="splunk-connector"></a>

**警告**  <a name="connectors-extended-life-phase-warning"></a>
此連接器已進入*延長的生命週期階段*， AWS IoT Greengrass 且不會發佈提供現有功能、增強功能、安全修補程式或錯誤修正的更新。如需詳細資訊，請參閱[AWS IoT Greengrass Version 1 維護政策](maintenance-policy.md)。

Splunk Integration [連接器](connectors.md)會將資料從 Greengrass 裝置發佈至 Splunk。這可讓您使用 Splunk 來監控和分析 Greengrass 核心環境，並對本機事件採取行動。連接器與 HTTP 事件收集器 (HEC) 整合。如需詳細資訊，請參閱 Splunk 文件中的 [Splunk HTTP 事件收集器簡介](https://dev.splunk.com/view/event-collector/SP-CAAAE6M)。

此連接器會接收 MQTT 主題上的記錄和事件資料，並將資料依現狀發佈到 Splunk API。

您可以使用此連接器來支援工業案例，例如：
+ 運算子可以使用來自傳動器和感應器的定期資料 （例如溫度、壓力和水讀數），在值超過特定閾值時啟動警示。
+ 開發人員使用從工業機械收集的資料，以建置機器學習模型來監控設備的潛在問題。

此連接器具有下列版本。


| 版本 | ARN | 
| --- | --- | 
| 4 | `arn:aws:greengrass:region::/connectors/SplunkIntegration/versions/4` | 
| 3 | `arn:aws:greengrass:region::/connectors/SplunkIntegration/versions/3` | 
| 2 | `arn:aws:greengrass:region::/connectors/SplunkIntegration/versions/2` | 
| 1 | `arn:aws:greengrass:region::/connectors/SplunkIntegration/versions/1` | 

如需版本變更的詳細資訊，請參閱 [Changelog](#splunk-connector-changelog)。

## 要求
<a name="splunk-connector-req"></a>

此連接器有下列要求：

------
#### [ Version 3 - 4 ]
+ <a name="conn-req-ggc-v1.9.3-secrets"></a>AWS IoT Greengrass 核心軟體 v1.9.3 或更新版本。 AWS IoT Greengrass 必須設定為支援本機秘密，如[秘密要求](secrets.md#secrets-reqs)中所述。
**注意**  
此要求包括允許存取您的 Secrets Manager 秘密。如果您使用的是預設 Greengrass 服務角色，Greengrass 具有許可，可取得名稱開頭為 *greengrass-* 的秘密值。
+ <a name="conn-req-py-3.7-and-3.8"></a>安裝在核心裝置上並新增至 PATH 環境變數的 [Python](https://www.python.org/) 3.7 或 3.8 版。
**注意**  <a name="use-runtime-py3.8"></a>
若要使用 Python 3.8，請執行下列命令，從預設 Python 3.7 安裝資料夾建立符號連結，以連接至已安裝的 Python 3.8 二進位檔。  

  ```
  sudo ln -s path-to-python-3.8/python3.8 /usr/bin/python3.7
  ```
這會設定您的裝置以符合 AWS IoT Greengrass的 Python 需求。
+ <a name="conn-splunk-req-http-event-collector"></a>Splunk 中必須啟用 HTTP 事件收集器功能。如需詳細資訊，請參閱 Splunk 文件中的[在 Splunk Web 中設定和使用 HTTP 事件收集器](https://docs.splunk.com/Documentation/Splunk/7.2.0/Data/UsetheHTTPEventCollector)。
+ <a name="conn-splunk-req-secret"></a>在 中 AWS Secrets Manager 存放 Splunk HTTP 事件收集器字符的文字類型秘密。如需詳細資訊，請參閱 Splunk 文件中的[關於事件收集器權杖](https://docs.splunk.com/Documentation/Splunk/7.2.0/Data/UsetheHTTPEventCollector#About_Event_Collector_tokens)和*AWS Secrets Manager 《 使用者指南*》中的[建立基本秘密](https://docs.aws.amazon.com/secretsmanager/latest/userguide/manage_create-basic-secret.html)。
**注意**  
若要在 Secrets Manager 主控台中建立秘密，請在**純文字**索引標籤上輸入您的字符。請勿包含引號或其他格式。在 API 中，指定字符做為 `SecretString` 屬性的值。
+ Greengrass 群組中參考 Secrets Manager 秘密的秘密資源。如需詳細資訊，請參閱[將秘密部署到 AWS IoT Greengrass 核心](secrets.md)。

------
#### [ Versions 1 - 2 ]
+ <a name="conn-req-ggc-v1.7.0-secrets"></a>AWS IoT Greengrass 核心軟體 v1.7 或更新版本。 AWS IoT Greengrass 必須設定為支援本機秘密，如[秘密要求](secrets.md#secrets-reqs)中所述。
**注意**  
此要求包括允許存取您的 Secrets Manager 秘密。如果您使用的是預設 Greengrass 服務角色，Greengrass 具有許可，可取得名稱開頭為 *greengrass-* 的秘密值。
+ [Python](https://www.python.org/) 2.7 版安裝在核心裝置上，並新增至 PATH 環境變數。
+ <a name="conn-splunk-req-http-event-collector"></a>Splunk 中必須啟用 HTTP 事件收集器功能。如需詳細資訊，請參閱 Splunk 文件中的[在 Splunk Web 中設定和使用 HTTP 事件收集器](https://docs.splunk.com/Documentation/Splunk/7.2.0/Data/UsetheHTTPEventCollector)。
+ <a name="conn-splunk-req-secret"></a>在 中 AWS Secrets Manager 存放 Splunk HTTP 事件收集器字符的文字類型秘密。如需詳細資訊，請參閱 Splunk 文件中的[關於事件收集器權杖](https://docs.splunk.com/Documentation/Splunk/7.2.0/Data/UsetheHTTPEventCollector#About_Event_Collector_tokens)和*AWS Secrets Manager 《 使用者指南*》中的[建立基本秘密](https://docs.aws.amazon.com/secretsmanager/latest/userguide/manage_create-basic-secret.html)。
**注意**  
若要在 Secrets Manager 主控台中建立秘密，請在**純文字**索引標籤上輸入您的字符。請勿包含引號或其他格式。在 API 中，指定字符做為 `SecretString` 屬性的值。
+ Greengrass 群組中參考 Secrets Manager 秘密的秘密資源。如需詳細資訊，請參閱[將秘密部署到 AWS IoT Greengrass 核心](secrets.md)。

------

## 連接器參數
<a name="splunk-connector-param"></a>

此連接器提供下列參數：

------
#### [ Version 4 ]

`SplunkEndpoint`  <a name="splunk-SplunkEndpoint"></a>
Splunk 執行個體的端點。這個值必須包含通訊協定、主機名稱和連接埠。  
 AWS IoT 主控台中的顯示名稱：**Splunk 端點**  
必要： `true`  
類型：`string`  
有效模式： `^(http:\/\/|https:\/\/)?[a-z0-9]+([-.]{1}[a-z0-9]+)*.[a-z]{2,5}(:[0-9]{1,5})?(\/.*)?$`

`MemorySize`  <a name="splunk-MemorySize"></a>
配置給連接器的記憶體數量 (KB)。  
 AWS IoT 主控台中的顯示名稱：**記憶體大小**  
必要： `true`  
類型：`string`  
有效模式： `^[0-9]+$`

`SplunkQueueSize`  <a name="splunk-SplunkQueueSize"></a>
提交或捨棄項目之前在記憶體中儲存的項目數上限。達到此限制時，佇列中最舊項目會由較新項目取代。此限制通常適用於未連接到網際網路時。  
在 AWS IoT 主控台中顯示名稱：**要保留的項目上限**  
必要： `true`  
類型：`string`  
有效模式： `^[0-9]+$`

`SplunkFlushIntervalSeconds`  <a name="splunk-SplunkFlushIntervalSeconds"></a>
將收到的資料發佈到 Splunk HEC 的間隔 (以秒為單位)。最大值為 900。若要將連接器設定為一收到項目就立刻將其發佈 (不批次處理)，請指定 0。  
 AWS IoT 主控台中的顯示名稱：**Splunk 發佈間隔**  
必要： `true`  
類型：`string`  
有效模式： `[0-9]|[1-9]\d|[1-9]\d\d|900`

`SplunkTokenSecretArn`  <a name="splunk-SplunkTokenSecretArn"></a>
中 AWS Secrets Manager 存放 Splunk 字符的秘密。這必須是文字類型私密。  
在 AWS IoT 主控台中顯示名稱：**Splunk 驗證字符秘密的 ARN**  
必要： `true`  
類型：`string`  
有效模式： `arn:aws:secretsmanager:[a-z]{2}-[a-z]+-\d{1}:\d{12}?:secret:[a-zA-Z0-9-_]+-[a-zA-Z0-9-_]+`

`SplunkTokenSecretArn-ResourceId`  <a name="splunk-SplunkTokenSecretArn-ResourceId"></a>
Greengrass 群組中參考 Splunk 私密的私密資源。  
 AWS IoT 主控台中的顯示名稱：**Splunk 驗證字符資源**  
必要： `true`  
類型：`string`  
有效模式： `.+`

`SplunkCustomCALocation`  <a name="splunk-SplunkCustomCALocation"></a>
Splunk 自訂憑證授權單位 (CA) 的檔案路徑 (例如 `/etc/ssl/certs/splunk.crt`)。  
 AWS IoT 主控台中的顯示名稱：**Splunk 自訂憑證授權單位位置**  
必要： `false`  
類型：`string`  
有效模式： `^$|/.*`

`IsolationMode`  <a name="IsolationMode"></a>
此連接器的[容器化](connectors.md#connector-containerization)模式。預設值為 `GreengrassContainer`，這表示連接器在 AWS IoT Greengrass 容器內的隔離執行時間環境中執行。  
群組的預設容器化設定不會套用至連接器。
在 AWS IoT 主控台中顯示名稱：**容器隔離模式**  
必要： `false`  
類型：`string`  
有效值：`GreengrassContainer` 或 `NoContainer`  
有效模式： `^NoContainer$|^GreengrassContainer$`

------
#### [ Version 1 - 3 ]

`SplunkEndpoint`  <a name="splunk-SplunkEndpoint"></a>
Splunk 執行個體的端點。這個值必須包含通訊協定、主機名稱和連接埠。  
 AWS IoT 主控台中的顯示名稱：**Splunk 端點**  
必要： `true`  
類型：`string`  
有效模式： `^(http:\/\/|https:\/\/)?[a-z0-9]+([-.]{1}[a-z0-9]+)*.[a-z]{2,5}(:[0-9]{1,5})?(\/.*)?$`

`MemorySize`  <a name="splunk-MemorySize"></a>
配置給連接器的記憶體數量 (KB)。  
 AWS IoT 主控台中的顯示名稱：**記憶體大小**  
必要： `true`  
類型：`string`  
有效模式： `^[0-9]+$`

`SplunkQueueSize`  <a name="splunk-SplunkQueueSize"></a>
提交或捨棄項目之前在記憶體中儲存的項目數上限。達到此限制時，佇列中最舊項目會由較新項目取代。此限制通常適用於未連接到網際網路時。  
在 AWS IoT 主控台中顯示名稱：**要保留的項目上限**  
必要： `true`  
類型：`string`  
有效模式： `^[0-9]+$`

`SplunkFlushIntervalSeconds`  <a name="splunk-SplunkFlushIntervalSeconds"></a>
將收到的資料發佈到 Splunk HEC 的間隔 (以秒為單位)。最大值為 900。若要將連接器設定為一收到項目就立刻將其發佈 (不批次處理)，請指定 0。  
 AWS IoT 主控台中的顯示名稱：**Splunk 發佈間隔**  
必要： `true`  
類型：`string`  
有效模式： `[0-9]|[1-9]\d|[1-9]\d\d|900`

`SplunkTokenSecretArn`  <a name="splunk-SplunkTokenSecretArn"></a>
中 AWS Secrets Manager 存放 Splunk 字符的秘密。這必須是文字類型私密。  
在 AWS IoT 主控台中顯示名稱：**Splunk 驗證字符秘密的 ARN**  
必要： `true`  
類型：`string`  
有效模式： `arn:aws:secretsmanager:[a-z]{2}-[a-z]+-\d{1}:\d{12}?:secret:[a-zA-Z0-9-_]+-[a-zA-Z0-9-_]+`

`SplunkTokenSecretArn-ResourceId`  <a name="splunk-SplunkTokenSecretArn-ResourceId"></a>
Greengrass 群組中參考 Splunk 私密的私密資源。  
 AWS IoT 主控台中的顯示名稱：**Splunk 驗證字符資源**  
必要： `true`  
類型：`string`  
有效模式： `.+`

`SplunkCustomCALocation`  <a name="splunk-SplunkCustomCALocation"></a>
Splunk 自訂憑證授權單位 (CA) 的檔案路徑 (例如 `/etc/ssl/certs/splunk.crt`)。  
 AWS IoT 主控台中的顯示名稱：**Splunk 自訂憑證授權單位位置**  
必要： `false`  
類型：`string`  
有效模式： `^$|/.*`

------

### 建立範例連接器 (AWS CLI)
<a name="splunk-connector-create"></a>

下列 CLI 命令`ConnectorDefinition`會使用包含 Splunk 整合連接器的初始版本來建立 。

```
aws greengrass create-connector-definition --name MyGreengrassConnectors --initial-version '{
    "Connectors": [
        {
            "Id": "MySplunkIntegrationConnector",
            "ConnectorArn": "arn:aws:greengrass:region::/connectors/SplunkIntegration/versions/4",
            "Parameters": {
                "SplunkEndpoint": "https://myinstance.cloud.splunk.com:8088",
                "MemorySize": 200000,
                "SplunkQueueSize": 10000,
                "SplunkFlushIntervalSeconds": 5,
                "SplunkTokenSecretArn":"arn:aws:secretsmanager:region:account-id:secret:greengrass-secret-hash",
                "SplunkTokenSecretArn-ResourceId": "MySplunkResource", 
                "IsolationMode" : "GreengrassContainer"
            }
        }
    ]
}'
```

**注意**  
此連接器中的 Lambda 函數具有[長期生命週期](lambda-functions.md#lambda-lifecycle)。

在 AWS IoT Greengrass 主控台中，您可以從群組的連接器頁面新增**連接器**。如需詳細資訊，請參閱[Greengrass 連接器入門 (主控台)](connectors-console.md)。

## 輸入資料
<a name="splunk-connector-data-input"></a>

此連接器接受 MQTT 主題上的記錄和事件資料，並將收到的資料依原樣發佈至 Splunk API。輸入訊息必須是 JSON 格式。

<a name="topic-filter"></a>**訂閱中的主題篩選條件**  
`splunk/logs/put`

**訊息屬性**    
`request`  
要傳送到 Splunk API 的事件資料。事件必須符合 [服務/收集器](https://docs.splunk.com/Documentation/Splunk/latest/RESTREF/RESTinput#services.2Fcollector) API 的規格。  
必要： `true`  
類型：`object`。只需要 `event` 屬性。  
`id`  
請求的任意 ID。此屬性用於將輸入請求映射到輸出狀態。  
必要： `false`  
類型：`string`

**限制**  
Splunk API 實施的所有限制，在使用此連接器時都適用。如需詳細資訊，請參閱[服務/收集器](https://docs.splunk.com/Documentation/Splunk/latest/RESTREF/RESTinput#services.2Fcollector)。

**範例輸入**  

```
{
    "request": {
        "event": "some event",
        "fields": {
            "severity": "INFO",
            "category": [
                "value1",
                "value2"
            ]
        }
    },
    "id": "request123"
}
```

## 輸出資料
<a name="splunk-connector-data-output"></a>

此連接器將輸出資料發佈在兩個主題：
+ `splunk/logs/put/status` 主題上的狀態資訊。
+ `splunk/logs/put/error`主題的相關錯誤。

**主題篩選條件：** `splunk/logs/put/status`  
使用此主題監聽請求的狀態。每次連接器將一批收到的資料傳送到 Splunk API 時，就會發佈成功請求和失敗請求的 ID 清單。    
**範例輸出**  

```
{
    "response": {
        "succeeded": [
            "request123",
            ...
        ],
        "failed": [
            "request789",
            ...
        ]
    }
}
```

**主題篩選條件：** `splunk/logs/put/error`  
使用此主題監聽來自連接器的錯誤。`error_message` 屬性，描述處理請求時發生的錯誤或逾時。    
**範例輸出**  

```
{
    "response": {
        "error": "UnauthorizedException",
        "error_message": "invalid splunk token",
        "status": "fail"
    }
}
```
如果連接器偵測到可重試的錯誤 （例如連線錯誤），則會在下一個批次中重試發佈。

## 使用範例
<a name="splunk-connector-usage"></a>

<a name="connectors-setup-intro"></a>使用下列高階步驟來設定範例 Python 3.7 Lambda 函數，您可以用來嘗試連接器。

**注意**  <a name="connectors-setup-get-started-topics"></a>
如果您使用其他 Python 執行期，則可以建立從 Python3.x 到 Python 3.7 的符號連結。
[連接器入門 (主控台)](connectors-console.md) 和 [連接器入門 (CLI)](connectors-cli.md) 主題包含詳細步驟，說明如何設定和部署範例 Twilio 通知連接器。

1. 確定您符合連接器的[要求](#splunk-connector-req)。

1. <a name="connectors-setup-function"></a>建立並發佈 Lambda 函數，將輸入資料傳送至連接器。

   將[範例程式碼](#splunk-connector-usage-example)儲存為 PY 檔案。<a name="connectors-setup-function-sdk"></a>下載並解壓縮[AWS IoT Greengrass 適用於 Python 的 核心 SDK](lambda-functions.md#lambda-sdks-core)。然後，建立在根層級包含 PY 檔案和 `greengrasssdk` 資料夾的 zip 套件。此 zip 套件是您上傳至 的部署套件 AWS Lambda。

   <a name="connectors-setup-function-publish"></a>建立 Python 3.7 Lambda 函數之後，請發佈函數版本並建立別名。

1. 設定 Greengrass 群組。

   1. <a name="connectors-setup-gg-function"></a>依別名新增 Lambda 函數 （建議）。將 Lambda 生命週期設定為長期 （或在 CLI `"Pinned": true`中）。

   1. <a name="connectors-setup-secret-resource"></a>新增必要的秘密資源，並授予 Lambda 函數的讀取存取權。

   1. 新增連接器並設定其[參數](#splunk-connector-param)。

   1. 新增訂閱，允許連接器在支援主題篩選條件上接收[輸入資料](#splunk-connector-data-input)並傳送[輸出資料](#splunk-connector-data-output)。
      + <a name="connectors-setup-subscription-input-data"></a>將 Lambda 函數設定為來源，將連接器設定為目標，並使用支援的輸入主題篩選條件。
      + <a name="connectors-setup-subscription-output-data"></a>將連接器設為來源、將 AWS IoT Core 設為目標，並使用支援的輸出主題篩選條件。您可以使用此訂閱在 AWS IoT 主控台中檢視狀態訊息。

1. <a name="connectors-setup-deploy-group"></a>部署群組。

1. <a name="connectors-setup-test-sub"></a>在 AWS IoT 主控台**的測試**頁面上，訂閱輸出資料主題，以檢視連接器的狀態訊息。Lambda 函數範例為長期函數，並在部署群組後立即開始傳送訊息。

   完成測試後，您可以將 Lambda 生命週期設定為隨需 （或在 CLI `"Pinned": false`中） 並部署群組。這會讓函數停止傳送訊息。

### 範例
<a name="splunk-connector-usage-example"></a>

下列範例 Lambda 函數會將輸入訊息傳送至連接器。

```
import greengrasssdk
import time
import json

iot_client = greengrasssdk.client('iot-data')
send_topic = 'splunk/logs/put'

def create_request_with_all_fields():
    return {
        "request": {
            "event": "Access log test message."
        },
        "id" : "req_123"
    }

def publish_basic_message():
    messageToPublish = create_request_with_all_fields()
    print("Message To Publish: ", messageToPublish)
    iot_client.publish(topic=send_topic,
        payload=json.dumps(messageToPublish))

publish_basic_message()

def lambda_handler(event, context):
    return
```

## 授權
<a name="splunk-connector-license"></a>

此連接器根據 [Greengrass 核心軟體授權合約](https://greengrass-release-license.s3.us-west-2.amazonaws.com/greengrass-license-v1.pdf)發行。

## 變更記錄
<a name="splunk-connector-changelog"></a>

下表說明每個連接器版本中的變更。


| 版本 | 變更 | 
| --- | --- | 
| 4 | <a name="isolation-mode-changelog"></a>已新增 `IsolationMode` 參數，以設定連接器的容器化模式。 | 
| 3 | <a name="upgrade-runtime-py3.7"></a>將 Lambda 執行時間升級至 Python 3.7，這會變更執行時間需求。 | 
| 2 | 可減少過多記錄的修正。 | 
| 1 | 初始版本。  | 

<a name="one-conn-version"></a>Greengrass 群組一次只能包含一個版本的連接器。若要取得有關升級連接器版本的資訊，請參閱[升級連接器版本](connectors.md#upgrade-connector-versions)。

## 另請參閱
<a name="splunk-connector-see-also"></a>
+ [使用 Greengrass 連接器來整合服務和通訊協定](connectors.md)
+ [Greengrass 連接器入門 (主控台)](connectors-console.md)
+ [Greengrass 連接器入門 (CLI)](connectors-cli.md)