Salesforce 输入插件
编辑Salesforce 输入插件
编辑- 插件版本: v3.2.1
- 发布日期: 2023-05-30
- 变更日志
对于其他版本，请参阅版本化插件文档。
获取帮助
编辑有关插件的问题，请在 Discuss 论坛中开启一个主题。对于错误或功能请求，请在 Github 中开启一个 issue。有关 Elastic 支持的插件列表，请查阅Elastic 支持矩阵。
描述
编辑此 Logstash 输入插件允许您使用 SOQL 查询 Salesforce，并将结果放入 Logstash 中，每个事件一行。您可以配置它以拉取整个 sObject 或仅拉取特定字段。
此输入插件将在处理完查询的所有结果后停止，并且需要重新运行以获取新结果。它不使用流式 API。
要使用此插件，您需要使用 oauth 创建一个新的 SFDC 应用程序。更多详细信息请参见：https://help.salesforce.com/apex/HTViewHelpDoc?id=connected_app_create.htm
您还需要 Salesforce 实例的用户名、密码和安全令牌。有关生成令牌的更多详细信息，请参见：https://help.salesforce.com/apex/HTViewHelpDoc?id=user_security_token.htm
除了指定 sObject，您还可以提供 SOQL 查询中将使用的 API 字段列表。
HTTP 代理
编辑如果您的基础架构使用 HTTP 代理，您可以使用所需的 URI 值设置 SALESFORCE_PROXY_URI 环境变量（例如，export SALESFORCE_PROXY_URI="http://proxy.example.com:123"）。
示例
编辑此示例将所有 Salesforce 机会输出到标准输出
input {
salesforce {
client_id => 'OAUTH CLIENT ID FROM YOUR SFDC APP'
client_secret => 'OAUTH CLIENT SECRET FROM YOUR SFDC APP'
username => '[email protected]'
password => 'super-secret'
security_token => 'SECURITY TOKEN FOR THIS USER'
sfdc_object_name => 'Opportunity'
}
}
output {
stdout {
codec => rubydebug
}
}
Salesforce 输入配置选项
编辑此插件支持以下配置选项以及稍后描述的通用选项。
| 设置 | 输入类型 | 必需 |
|---|---|---|
否 |
||
是 |
||
是 |
||
是 |
||
是 |
||
否 |
||
否 |
||
否 |
||
是 |
||
否 |
||
否 |
||
否 |
||
是 |
另请参阅通用选项，了解所有输入插件支持的选项列表。
client_id
编辑- 这是一个必需的设置。
- 值类型为字符串
- 此设置没有默认值。
用于身份验证的消费者密钥。您必须使用 oath 设置一个新的 SFDC 连接应用程序才能使用此输出。更多信息请参见：https://help.salesforce.com/apex/HTViewHelpDoc?id=connected_app_create.htm
security_token
编辑- 这是一个必需的设置。
- 值类型为密码
- 此设置没有默认值。
此帐户的安全令牌。有关生成安全令牌的更多信息，请参阅：https://help.salesforce.com/apex/HTViewHelpDoc?id=user_security_token.htm
sfdc_filters
编辑- 值类型为字符串
- 默认值为
""
这些选项将添加到 SOQL 语句的 WHERE 子句中。可以通过添加 field1 = value1 AND field2 = value2 AND... 来过滤其他字段
sfdc_instance_url
编辑- 值类型为字符串
- 此设置没有默认值。
Salesforce 实例的 URL。如果您想连接到您的 Salesforce 实例而不是 login.salesforce.com 或登录时的 test.salesforce.com，请提供 URL。
使用此选项或 use_test_sandbox 配置选项，但不要同时使用两者来配置插件连接到的 URL。
use_test_sandbox
编辑- 值类型为布尔值
- 默认值为
false
将其设置为 true 以通过 test.salesforce.com 连接到沙盒 sfdc 实例进行登录
使用此选项或 sfdc_instance_url 配置选项，但不要同时使用两者来配置插件连接到的 URL。
use_tooling_api
编辑- 值类型为布尔值
- 默认值为
false
将其设置为 true 以连接到 sfdc 工具 API 而不是常规的 sfdc rest API。 有关 sfdc 工具 API 的详细信息，请参阅 https://developer.salesforce.com/docs/atlas.en-us.api_tooling.meta/api_tooling。 sfdc 工具 API 的用例包括读取 apex 单元测试结果、流程覆盖率结果（例如，sfdc 流程元素的覆盖率）和安全健康检查风险。