« 通过 SNS/SQS 插件使用 S3 SNMP 输入插件 »
Elastic 文档 ›Logstash 参考 [8.14] ›输入插件

Salesforce 输入插件

编辑

Salesforce 输入插件编辑

  • 插件版本：v3.2.1
  • 发布日期：2023-05-30
  • 变更日志

有关其他版本，请参阅 版本化插件文档。

安装编辑

对于默认情况下未捆绑的插件，可以通过运行 bin/logstash-plugin install logstash-input-salesforce 轻松安装。有关更多详细信息，请参阅 使用插件。

获取帮助编辑

有关插件的问题，请在 Discuss 论坛中发布主题。对于错误或功能请求，请在 Github 中创建问题。有关 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 输入配置选项编辑

此插件支持以下配置选项，以及后面描述的 通用选项。

设置 输入类型 必需

api_version

字符串

否

client_id

字符串

是

client_secret

密码

是

密码

密码

是

security_token

密码

是

sfdc_fields

数组

否

sfdc_filters

字符串

否

sfdc_instance_url

字符串

否

sfdc_object_name

字符串

是

to_underscores

布尔值

否

use_test_sandbox

布尔值

否

use_tooling_api

布尔值

否

username

字符串

是

另请参阅 通用选项，了解所有输入插件支持的选项列表。

 

api_version编辑

  • 值类型为 字符串
  • 此设置没有默认值。

默认情况下，这使用默认的 Restforce API 版本。要覆盖此版本，请将其设置为类似于“32.0”的内容。

client_id编辑

  • 这是一个必需的设置。
  • 值类型为 字符串
  • 此设置没有默认值。

用于身份验证的消费者密钥。您必须使用 oath 设置一个新的 SFDC 连接的应用程序才能使用此输出。更多信息，请参阅：https://help.salesforce.com/apex/HTViewHelpDoc?id=connected_app_create.htm

client_secret编辑

  • 这是一个必需的设置。
  • 值类型为 密码
  • 此设置没有默认值。

来自您启用了 oauth 的连接应用程序的消费者密钥

password编辑

  • 这是一个必需的设置。
  • 值类型为 密码
  • 此设置没有默认值。

用于登录 sfdc 的密码

security_token编辑

  • 这是一个必需的设置。
  • 值类型为 密码
  • 此设置没有默认值。

此帐户的安全令牌。有关生成安全令牌的更多信息，请参阅：https://help.salesforce.com/apex/HTViewHelpDoc?id=user_security_token.htm

sfdc_fields编辑

  • 值类型为 数组
  • 默认值为 []

这些是在 Salesforce 查询中返回的字段名称。如果为空，则返回所有字段。

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。

sfdc_object_name编辑

  • 这是一个必需的设置。
  • 值类型为 字符串
  • 此设置没有默认值。

您要创建或更新的 Salesforce 对象的名称

to_underscores编辑

将其设置为 true 将转换 SFDC 的 NamedFieldsc 为 named_fieldsc

use_test_sandbox编辑

将其设置为 true 以连接到沙盒 sfdc 实例，通过 test.salesforce.com 登录。

使用此选项或 sfdc_instance_url 配置选项，但不要同时使用两者来配置插件连接到的 URL。

use_tooling_api编辑

将其设置为 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 流程元素的覆盖率）和安全健康检查风险。

username编辑

  • 这是一个必需的设置。
  • 值类型为 字符串
  • 此设置没有默认值。

有效的 Salesforce 用户名，通常是您的电子邮件地址。用于身份验证，并将是所有对象创建或修改的用户的用户名。

通用选项编辑

以下配置选项由所有输入插件支持

设置 输入类型 必需

add_field

hash

否

enable_metric

布尔值

否

id

字符串

否

tags

数组

否

type

字符串

否

详细信息编辑

 

add_field编辑

  • 值类型为 哈希
  • 默认值为 {}

将字段添加到事件中

enable_metric编辑

禁用或启用此特定插件实例的指标日志记录。默认情况下，我们会记录所有可能的指标，但您可以为特定插件禁用指标收集。

id编辑

  • 值类型为 字符串
  • 此设置没有默认值。

在插件配置中添加一个唯一的 ID。如果未指定 ID，Logstash 将生成一个。强烈建议在配置中设置此 ID。当您有两个或多个相同类型的插件时，这尤其有用，例如，如果您有两个 Salesforce 输入。在这种情况下，添加命名 ID 将有助于在使用监控 API 时监控 Logstash。

input {
  salesforce {
    id => "my_plugin_id"
  }
}

id 字段中的变量替换仅支持环境变量，不支持使用密钥存储中的值。

tags编辑

  • 值类型为 数组
  • 此设置没有默认值。

向您的事件添加任意数量的任意标签。

这可以帮助以后的处理。

type编辑

  • 值类型为 字符串
  • 此设置没有默认值。

向此输入处理的所有事件添加 type 字段。

类型主要用于过滤器激活。

类型存储为事件本身的一部分，因此您也可以使用类型在 Kibana 中搜索它。

如果您尝试在已经具有类型的事件上设置类型（例如，当您从发件人发送事件到索引器时），则新的输入不会覆盖现有类型。在发件人处设置的类型会一直保留在该事件中，即使它被发送到另一个 Logstash 服务器也是如此。

« 通过 SNS/SQS 插件使用 S3 SNMP 输入插件 »