Splunk

Com o conector do Splunk, é possível executar operações de inserção, exclusão, atualização e leitura no banco de dados do Splunk.

Antes de começar

Antes de usar o conector do Splunk, faça as seguintes tarefas:

  • No seu projeto do Google Cloud, faça o seguinte:
    • Conceda o papel do IAM roles/connectors.admin ao usuário que estiver configurando o conector.
    • Conceda os seguintes papéis de IAM à conta de serviço que você quer usar para o conector:
      • roles/secretmanager.viewer
      • roles/secretmanager.secretAccessor

      Uma conta de serviço é um tipo especial de Conta do Google destinada a representar um usuário não humano que precisa ser autenticado e autorizado a acessar dados nas APIs do Google. Se você não tiver uma conta de serviço, será necessário criar uma. Para mais informações, consulte Como criar uma conta de serviço.

    • Ative os seguintes serviços:
      • secretmanager.googleapis.com (API Secret Manager)
      • connectors.googleapis.com (API Connectors)

      Para entender como ativar os serviços, consulte Como ativar serviços.

    Se esses serviços ou permissões não tiverem sido ativados no seu projeto, você precisará ativá-los ao configurar o conector.

Configurar o conector

Para configurar o conector, crie uma conexão com a fonte de dados (sistema de back-end). Uma conexão é específica a uma fonte de dados. Isso significa que, se você tiver muitas fontes de dados, precisará criar uma conexão separada para cada uma. Para criar uma conexão, siga estas etapas:

  1. No console do Cloud, acesse a página Integration Connectors > Conexões e selecione ou crie um projeto do Google Cloud.

    Acesse a página "Conexões"

  2. Clique em + CRIAR NOVO para abrir a página Criar conexão.
  3. Na seção Local, escolha o local da conexão.
    1. Região: selecione um local na lista suspensa.

      Para acessar a lista de todas as regiões com suporte, consulte Locais.

    2. Clique em PRÓXIMA.
  4. Na seção Detalhes da conexão, faça o seguinte:
    1. Conector: selecione Splunk na lista suspensa de conectores disponíveis.
    2. Versão do conector: selecione a versão do conector na lista suspensa de versões disponíveis.
    3. No campo Nome da conexão, insira um nome para a instância de conexão

      Os nomes de conexão precisam atender aos seguintes critérios:

      • Os nomes de conexões podem usar letras, números ou hifens.
      • As letras precisam ser minúsculas.
      • Os nomes das conexões precisam começar com uma letra e terminar com uma letra ou um número.
      • Os nomes das conexões não podem exceder 63 caracteres.
    4. Como opção, insira uma Descrição para a instância de conexão.
    5. Conta de serviço: selecione uma conta de serviço que tenha os papéis necessários.
    6. Opcionalmente, defina as Configurações do nó de conexão:

      • Número mínimo de nós: digite o número mínimo de nós de conexão.
      • Número máximo de nós: digite o número máximo de nós de conexão.

      Um nó é uma unidade (ou réplica) de uma conexão que processa transações. Mais nós são necessários para processar mais transações para uma conexão e, por outro lado, menos nós são necessários para processar menos transações. Para entender como os nós afetam os preços do conector, consulte Preços dos nós de conexão. Se você não inserir qualquer valor, por padrão, os nós mínimos serão definidos como 2 (para melhor disponibilidade) e os nós máximos serão definidos como 50.

    7. Outra opção é clicar em + ADICIONAR MARCADOR para adicionar um rótulo à conexão na forma de um par de chave-valor.
    8. Clique em PRÓXIMA.
  5. Na seção Destinos, insira os detalhes do host remoto (sistema de back-end) ao qual você quer se conectar.
    1. Tipo de destino: selecione um Tipo de destino.
      1. No campo Endereço do host, especifique o nome do host ou o endereço IP do destino.
        1. Se você quiser estabelecer uma conexão privada com seus sistemas de back-end, siga estas etapas:
          1. Crie um anexo do serviço PSC.
          2. Crie um anexo de endpoint e insira os detalhes dele no campo Endereço do host.
        2. Para estabelecer uma conexão pública com os sistemas de back-end com mais segurança, considere configurar endereços IP de saída estáticos para suas conexões e configure as regras de firewall para autorizar apenas os endereços IP estáticos específicos.

      Para inserir outros destinos, clique em +ADICIONAR DESTINO.

    2. Clique em PRÓXIMA.
  6. Na seção Autenticação, insira os detalhes da autenticação.
    1. Selecione um Tipo de autenticação e insira os detalhes relevantes.

      Os seguintes tipos de autenticação oferecem suporte à conexão do Splunk:

      • Nome de usuário e senha (autenticação básica)
      • AccessToken
      • HTTPEventCollectorToken
    2. Para entender como configurar esses tipos de autenticação, consulte Configurar autenticação.

    3. Clique em PRÓXIMA.
  7. Revisão: revise os detalhes de conexão e autenticação.
  8. Clique em Criar.

Configurar a autenticação

Digite os detalhes com base na autenticação que você quer usar.

  • Nome de usuário e senha
    • Nome de usuário: o nome de usuário do Splunk a ser usado para a conexão.
    • Senha: o Secret do Secret Manager que contém a senha associada ao nome de usuário do Splunk.
  • AccessToken: defina-o para realizar a autenticação baseada em token usando a propriedade AccessToken.
  • HTTPEventCollectorToken: defina para realizar a autenticação baseada em token usando a propriedade HTTPEventCollectorToken.

Entidades, operações e ações

Todos os Integration Connectors fornecem uma camada de abstração para os objetos do aplicativo conectado. Só é possível acessar os objetos de um aplicativo por esta abstração. A abstração é exposta a você como entidades, operações e ações.

  • Entidade: uma entidade pode ser considerada um objeto ou um conjunto de propriedades no aplicativo ou serviço conectado. A definição de uma entidade difere de um conector para outro. Por exemplo, em um conector de banco de dados, as tabelas são as entidades, em um conector de servidor de arquivos, as pastas são as entidades e, em um conector de sistema de mensagens, as filas são as entidades.

    No entanto, é possível que um conector não aceite ou não tenha entidades. Nesse caso, a lista Entities estará vazia.

  • Operação: uma operação é a atividade que pode ser realizada em uma entidade. É possível executar qualquer uma das seguintes operações em uma entidade:

    Selecionar uma entidade na lista disponível gera uma lista de operações disponíveis para ela. Para uma descrição detalhada das operações, consulte as operações de entidades da tarefa "Conectores". No entanto, se um conector não oferecer suporte a nenhuma das operações da entidade, essas operações não serão listadas na lista Operations.

  • Ação: uma ação é uma função de primeira classe disponibilizada para a integração por meio da interface do conector. Uma ação permite fazer alterações em uma ou mais entidades e varia de um conector para outro. No entanto, é possível que o conector não ofereça suporte a nenhuma ação. Nesse caso, a lista Actions estará vazia.

Limitações do sistema

O conector do Splunk pode processar cinco transações por segundo, por , e limitar todas as transações além desse limite. No entanto, o número de transações que esse conector pode processar também depende das restrições impostas pela instância do Splunk. Por padrão, os Integration Connectors alocam dois nós (para melhor disponibilidade) para uma conexão.

Para informações sobre os limites aplicáveis aos Integration Connectors, consulte Limites.

Ações

Nesta seção, listamos as ações compatíveis com o conector. Para entender como configurar as ações, consulte Exemplos de ação.

Ação CreateHTTPEvent

Assim, você pode enviar dados e eventos de aplicativos para uma implantação do Splunk pelos protocolos HTTP e HTTPS.

Parâmetros de entrada da ação CreateHTTPEvent

Nome do parâmetro Tipo de dados Obrigatório Descrição
EventContent String Sim O nome da tabela ou visualização.
ContentType String Não O tipo de conteúdo especificado para a entrada EventContent. Os valores aceitos são JSON e RAWTEXT.
ChannelGUID Inteiro Não O GUID do canal usado para o evento. Será necessário especificar esse valor se ContentType for RAWTEXT.

Parâmetros de saída da ação CreateHTTPEvent

Essa ação retorna o status de êxito do evento criado.

Ação CreateIndex

Essa ação permite criar índices.

Parâmetros de entrada da ação CreateIndex

Nome do parâmetro Tipo de dados Obrigatório Descrição
MaxMetaEntries String Não Define o número máximo de linhas exclusivas em arquivos .data em um bucket, o que pode ajudar a reduzir o consumo de memória.
FrozenTimePeriodInSecs String Não Número de segundos após os quais os dados indexados passam para congelados. O padrão é 188697600 (6 anos).
HomePath String Não Um caminho absoluto que contém os buckets ativos e quentes do índice.
MinRawFileSyncSecs String Não Especifique um número inteiro (ou disable) para esse parâmetro. Esse parâmetro define a frequência com que o "splunkd" força uma sincronização do sistema de arquivos ao compactar frações do diário.
ProcessTrackerServiceInterval String Não Especifica, em segundos, com que frequência o indexador verifica o status dos processos do SO filho iniciados para ver se é possível iniciar novos processos para solicitações na fila. Se este campo for definido como 0, o indexador verificará o status do processo filho a cada segundo.
ServiceMetaPeriod String Não Define com que frequência (em segundos) os metadados são sincronizados com o disco.
MaxHotSpanSecs String Não Limite superior do período máximo desejado (em segundos) de buckets quentes ou mornos.
QuarantinePastSecs String Não Eventos com carimbo de data/hora de quarentenaPastSecs anteriores a >now são colocados no bucket de quarentena.
ColdToFrozenDir String Não Caminho de destino do arquivo congelado. Use como alternativa a um ColdToFrozenScript.
ColdPath String Não Um caminho absoluto que contém os colddbs para o índice. O caminho precisa ser legível e gravável.
MaxHotIdleSecs String Não A vida útil máxima, em segundos, de um bucket quente
WarmToColdScript String Não Caminho para um script a ser executado ao mover dados de quentes para frios.
ColdToFrozenScript String Não Caminho para o script de arquivamento.
MaxHotBuckets String Não Máximo de buckets ativos que podem existir por índice.
TstatsHomePath String Não Local para armazenar dados TSIDX de aceleração do modelo de dados para este índice. Se especificado, ele precisa ser definido em termos de uma definição de volume. O caminho precisa ser gravável
RepFactor String Não Controle de replicação do índice Esse parâmetro se aplica apenas aos nós de peering no cluster.
  • auto: usa o valor de configuração de replicação do índice mestre.
  • 0: desativa a replicação para este índice.
MaxDataSize String Não O tamanho máximo em MB que um banco de dados quente deve alcançar antes que uma rolagem para aquecimento seja acionada. Especificar auto ou auto_high_volume faz com que o Splunk ajuste automaticamente esse parâmetro (recomendado).
MaxBloomBackfillBucketAge String Não Os valores válidos são: integer[m|s|h|d]. Se um bucket quente ou frio for mais antigo do que a idade especificada, não crie ou recrie o filtro Bloom. Especifique 0 para nunca recriar filtros de Bloom.
BlockSignSize String Não Controla quantos eventos compõem um bloco de assinaturas bloqueadas. Se for definido como 0, a assinatura de blocos será desativada para esse índice. O valor recomendado é 100.
Nome String Sim O nome do índice a ser criado
MaxTotalDataSizeMB String Não O tamanho máximo de um índice (em MB). Se um índice ficar maior do que o tamanho máximo, os dados mais antigos serão congelados.
MaxWarmDBCount String Não O número máximo de buckets quentes. Se esse número for excedido, os buckets com o valor mais baixo nos últimos horários serão movidos para o modo frio.
RawChunkSizeBytes String Não Segmente o tamanho descompactado em bytes da fração bruta individual no diário de dados brutos do índice. Zero não é um valor válido. Se 0 for especificado, brutoChunkSizeBytes será definido como o valor padrão.
DataType String Não Especifica o tipo de índice
MaxConcurrentOptimizes String Não O número de processos de otimização simultâneos que podem ser executados em um bucket ativo.
ThrottleCheckPeriod String Não Define a frequência (em segundos) com que o Splunk verifica a condição de limitação do índice.
SyncMeta String Não Quando verdadeiro, uma operação de sincronização é chamada antes que o descritor do arquivo seja fechado nas atualizações do arquivo de metadados. Essa funcionalidade melhora a integridade dos arquivos de metadados, especialmente em relação a falhas do sistema operacional ou da máquina.
RotatePeriodInSecs String Não Com que frequência (em segundos) verificar se um novo bucket quente precisa ser criado. Além disso, com que frequência verificar se há buckets quentes/frios que precisam ser lançados/congelados.

Parâmetros de saída da ação CreateIndex

Esta ação retorna a mensagem de confirmação da ação CreateIndex.

Para um exemplo sobre como configurar a ação CreateIndex, consulte Exemplos de ação.

Ação CreateSavedSearch

Com isso, você pode salvar suas pesquisas

Parâmetros de entrada da ação CreateSavedSearch

Nome do parâmetro Tipo de dados Obrigatório Descrição
IsVisible Booleano Sim Indica se essa pesquisa salva aparece na lista de pesquisas salvas visível.
RealTimeSchedule Booleano Sim Se esse valor for definido como 1, o programador baseará a determinação do próximo tempo de execução da pesquisa programada no horário atual. Se esse valor for definido como 0, ele será determinado com base no último tempo de execução da pesquisa.
Pesquisar String Sim A consulta de pesquisa a ser salva
Descrição String Não Descrição desta pesquisa salva
SchedulePriority String Sim Indica a prioridade de programação de uma pesquisa específica
CronSchedule String Sim A programação cron para executar esta pesquisa. Por exemplo, */5 * * * * faz com que a pesquisa seja executada a cada cinco minutos.
Nome String Sim Um nome para a pesquisa
UserContext String Sim Se o contexto do usuário for fornecido, o nó servicesNS será usado (/servicesNS/[UserContext]/search). Caso contrário, o padrão será o endpoint geral, /services.
RunOnStartup Booleano Sim Indica se esta pesquisa é executada na inicialização. Se não for executada na inicialização, a pesquisa será executada no próximo horário programado.
Desativado Booleano Não Indica se essa pesquisa salva está desativada.
IsScheduled Booleano Sim Indica se esta pesquisa deve ser executada em uma programação.

Parâmetros de saída da ação CreateSavedSearch

Esta ação retorna a mensagem de confirmação da ação CreateSavedSearch.

Para um exemplo sobre como configurar a ação CreateSavedSearch, consulte Exemplos de ação.

Ação AtualizarPesquisa salva

Essa ação permite atualizar uma pesquisa salva.

Parâmetros de entrada da ação UpdateSavedSearch

Nome do parâmetro Tipo de dados Obrigatório Descrição
IsVisible Booleano Sim Indica se essa pesquisa salva aparece na lista de pesquisas salvas visível.
RealTimeSchedule Booleano Sim Se esse valor for definido como 1, o programador baseará a determinação do próximo tempo de execução da pesquisa programada no horário atual. Se esse valor for definido como 0, ele será determinado com base no último tempo de execução da pesquisa.
Pesquisar String Sim A consulta de pesquisa a ser salva
Descrição String Não Descrição desta pesquisa salva
SchedulePriority String Sim Indica a prioridade de programação de uma pesquisa específica
CronSchedule String Sim A programação cron para executar esta pesquisa. Por exemplo, */5 * * * * faz com que a pesquisa seja executada a cada cinco minutos.
Nome String Sim Um nome para a pesquisa
UserContext String Sim Se o contexto do usuário for fornecido, o nó servicesNS será usado (/servicesNS/[UserContext]/search). Caso contrário, o padrão será o endpoint geral, /services.
RunOnStartup Booleano Sim Indica se esta pesquisa é executada na inicialização. Se não for executada na inicialização, a pesquisa será executada no próximo horário programado.
Desativado Booleano Não Indica se essa pesquisa salva está desativada.
IsScheduled Booleano Sim Indica se esta pesquisa deve ser executada em uma programação.

Parâmetros de saída da ação UpdateSavedSearch

Esta ação retorna a mensagem de confirmação da ação UpdateSavedSearch.

Para um exemplo sobre como configurar a ação UpdateSavedSearch, consulte Exemplos de ação.

Ação DeleteIndex

Essa ação permite excluir um índice.

Parâmetros de entrada da ação DeleteIndex

Nome do parâmetro Tipo de dados Obrigatório Descrição
Nome String Sim O nome do índice a ser excluído.

Parâmetros de saída da ação DeleteIndex

Esta ação retorna a mensagem de confirmação da ação DeleteIndex

Para um exemplo sobre como configurar a ação DeleteIndex, consulte Exemplos de ação.

Ação UpdateIndex

Essa ação permite atualizar um índice.

Parâmetros de entrada da ação UpdateIndex

Nome do parâmetro Tipo de dados Obrigatório Descrição
MaxMetaEntries String Não Define o número máximo de linhas exclusivas em arquivos .data em um bucket, o que pode ajudar a reduzir o consumo de memória.
FrozenTimePeriodInSecs String Não Número de segundos após os quais os dados indexados passam para congelados. O padrão é 188697600 (6 anos).
HomePath String Não Um caminho absoluto que contém os buckets ativos e quentes do índice.
MinRawFileSyncSecs String Não Especifique um número inteiro (ou disable) para esse parâmetro. Esse parâmetro define a frequência com que o "splunkd" força uma sincronização do sistema de arquivos ao compactar frações do diário.
ProcessTrackerServiceInterval String Não Especifica, em segundos, com que frequência o indexador verifica o status dos processos do SO filho iniciados para ver se é possível iniciar novos processos para solicitações na fila. Se esse valor for definido como 0, o indexador verificará o status do processo filho a cada segundo.
ServiceMetaPeriod String Não Define com que frequência (em segundos) os metadados são sincronizados com o disco.
MaxHotSpanSecs String Não Limite superior do período máximo desejado (em segundos) de buckets quentes ou mornos.
QuarantinePastSecs String Não Eventos com carimbo de data/hora de quarentenaPastSecs anteriores a now são colocados no bucket de quarentena.
ColdToFrozenDir String Não Caminho de destino do arquivo congelado. Use como alternativa a um ColdToFrozenScript.
ColdPath String Não Um caminho absoluto que contém os colddbs para o índice. O caminho precisa ser legível e gravável.
MaxHotIdleSecs String Não A vida útil máxima, em segundos, de um bucket quente.
WarmToColdScript String Não Caminho para um script a ser executado ao mover dados de quentes para frios.
ColdToFrozenScript String Não Caminho para o script de arquivamento.
MaxHotBuckets String Não Máximo de buckets ativos que podem existir por índice.
TstatsHomePath String Não Local para armazenar dados TSIDX de aceleração do modelo de dados para este índice. Se especificado, ele precisa ser definido em termos de uma definição de volume. O caminho precisa ser gravável
RepFactor String Não Controle de replicação do índice Esse parâmetro se aplica apenas aos nós de peering no cluster.
  • auto: usa o valor de configuração de replicação do índice mestre.
  • 0: desativa a replicação para este índice.
MaxDataSize String Não O tamanho máximo em MB que um banco de dados quente deve alcançar antes que uma rolagem para aquecimento seja acionada. Especificar auto ou auto_high_volume faz com que o Splunk ajuste automaticamente esse parâmetro (recomendado).
MaxBloomBackfillBucketAge String Não Os valores válidos são: integer[m|s|h|d]. Se um bucket quente ou frio for mais antigo do que a idade especificada, não crie nem recrie o filtro de bloom. Especifique 0 para nunca recriar filtros de Bloom.
BlockSignSize String Não Controla quantos eventos compõem um bloco de assinaturas bloqueadas. Se for definido como 0, a assinatura de blocos será desativada para o índice. O valor recomendado é 100.
Nome String Sim O nome do índice a ser criado
MaxTotalDataSizeMB String Sim O tamanho máximo de um índice (em MB). Se um índice ficar maior do que o tamanho máximo, os dados mais antigos serão congelados.
MaxWarmDBCount String Não O número máximo de buckets quentes. Se esse número for excedido, os buckets com o valor mais baixo nos últimos horários serão movidos para o modo frio.
RawChunkSizeBytes String Não Segmente o tamanho descompactado em bytes da fatia bruta individual no diário de dados brutos do índice. Zero não é um valor válido. Se 0 for especificado, brutoChunkSizeBytes será definido como o valor padrão.
DataType String Não Especifica o tipo de índice
MaxConcurrentOptimizes String Não O número de processos de otimização simultâneos que podem ser executados em um bucket ativo.
ThrottleCheckPeriod String Não Define a frequência (em segundos) com que o Splunk verifica a condição de limitação do índice.
SyncMeta String Não Quando verdadeiro, uma operação de sincronização é chamada antes que o descritor do arquivo seja fechado nas atualizações do arquivo de metadados. Essa funcionalidade melhora a integridade dos arquivos de metadados, especialmente no que diz respeito a falhas do sistema operacional ou da máquina.
RotatePeriodInSecs String Não Com que frequência (em segundos) verificar se um novo bucket quente precisa ser criado. Além disso, com que frequência verificar se há buckets quentes ou frios que precisam ser rolados ou congelados.

Parâmetros de saída da ação UpdateIndex

Esta ação retorna a mensagem de confirmação da ação UpdateIndex.

Para um exemplo sobre como configurar a ação UpdateIndex, consulte Exemplos de ação.

Exemplos de ação

Exemplo: criar um evento HTTP

Neste exemplo, criamos um evento HTTP.

  1. Na caixa de diálogo Configure connector task, clique em Actions.
  2. Selecione a ação CreateHTTPEvent e clique em Concluído.
  3. Na seção Task Input da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value:
    {
    "EventContent": "Testing Task",
    "ContentType": "RAWTEXT",
    "ChannelGUID": "ContentType=RAWTEXT"
    }
  4. Se a ação for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa CreateHTTPEvent terá um valor semelhante a este:

    [{
    "Success": "Success"
    }]
    

Exemplo: criar um índice

Neste exemplo, criamos um índice.

  1. Na caixa de diálogo Configure connector task, clique em Actions.
  2. Selecione a ação CreateIndex e clique em Concluído.
  3. Na seção Task Input da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value:
    {
    "Name": "http_testing"
    }
  4. Se a ação for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa CreateIndex terá um valor semelhante a este:

    [{
    "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,
    }]

Este exemplo cria uma pesquisa salva.

  1. Na caixa de diálogo Configure connector task, clique em Actions.
  2. Selecione a ação CreateSavedSearch e clique em Concluído.
  3. Na seção Task Input da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value:
    {
    "Name": "test_created_g",
    "Search": "index=\"http_testing\"",
    "CronSchedule": "*/1 * * * *",
    "IsVisible": true,
    "RealTimeSchedule": true,
    "RunOnStartup": true,
    "IsScheduled": true,
    "SchedulePriority": "highest",
    "UserContext": "nobody"
    }
  4. Se a ação for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa CreateSavedSearch terá um valor semelhante a este:

    [{
    "Success": true,
    "Message": null
    }]

Este exemplo atualiza uma pesquisa salva.

  1. Na caixa de diálogo Configure connector task, clique em Actions.
  2. Selecione a ação UpdateSavedSearch e clique em Concluído.
  3. Na seção Task Input da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value:
    {
    "Name": "test_created_g",
    "Search": "index=\"december_test_data\"",
    "CronSchedule": "*/1 * * * *",
    "IsVisible": true,
    "RealTimeSchedule": true,
    "RunOnStartup": true,
    "IsScheduled": true,
    "SchedulePriority": "highest"
    }
  4. Se a ação for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa UpdateSavedSearch terá um valor semelhante a este:

    [{
    "Success": true,
    "Message": null
    }]

Exemplo: excluir um índice

Neste exemplo, um índice é excluído.

  1. Na caixa de diálogo Configure connector task, clique em Actions.
  2. Selecione a ação DeleteIndex e clique em Concluído.
  3. Na seção Task Input da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value:
    {
    "Name": "g_http_testing"
    }
  4. Se a ação for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa DeleteIndex terá um valor semelhante a este:

    [{
    "Success": true,
    "ErrorCode": null,
    "ErrorMessage": null
    }]

Exemplo: atualizar um índice

Este exemplo atualiza um índice.

  1. Na caixa de diálogo Configure connector task, clique em Actions.
  2. Selecione a ação UpdateIndex e clique em Concluído.
  3. Na seção Task Input da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo Default Value:
    {
    "MaxTotalDataSizeMB": "400000",
    "Name": "g_http_testing"
    }
  4. Se a ação for bem-sucedida, o parâmetro de resposta connectorOutputPayload da tarefa UpdateIndex terá um valor semelhante a este:

    [{
    "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
    }]

Exemplos de operação de entidade

Esta seção mostra como executar algumas das operações da entidade no conector.

Exemplo: listar todos os registros

Neste exemplo, listamos todos os registros na entidade SearchJobs.

  1. Na caixa de diálogo Configure connector task, clique em Entities.
  2. Selecione SearchJobs na lista de Entity.
  3. Selecione a operação List e clique em Concluído.
  4. Como opção, na seção Task Input da tarefa Connectors, é possível filtrar o conjunto de resultados especificando uma cláusula de filtro. Especifique o valor da cláusula de filtro sempre entre aspas simples (').

Exemplo: receber um registro de uma entidade

Este exemplo recebe um registro com o ID especificado da entidade SearchJobs.

  1. Na caixa de diálogo Configure connector task, clique em Entities.
  2. Selecione SearchJobs na lista de Entity.
  3. Selecione a operação Get e clique em Concluído.
  4. Na seção Task Input da tarefa Connectors, clique em EntityId e insira 1698309163.1300 no campo Valor padrão.

    Aqui, 1698309163.1300 é um ID de registro exclusivo na entidade SearchJobs.

Exemplo: criar um registro em uma entidade

Este exemplo cria um registro na entidade DataModels.

  1. Na caixa de diálogo Configure connector task, clique em Entities.
  2. Selecione DataModels na lista de Entity.
  3. Selecione a operação Create e clique em Concluído.
  4. Na seção Task Input da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo 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\":\"\"}"
    }

    Se a integração for bem-sucedida, o campo connectorOutputPayload da tarefa do conector terá um valor semelhante a este:

    [{
    "Id": "Test1"
    }]

Exemplo: excluir um registro de uma entidade

Este exemplo exclui o registro com o ID especificado na entidade DataModels.

  1. Na caixa de diálogo Configure connector task, clique em Entities.
  2. Selecione DataModels na lista de Entity.
  3. Selecione a operação Delete e clique em Concluído.
  4. Na seção Entrada da tarefa da tarefa Conectores, clique em entityId e insira Test1 no campo Valor padrão.

Exemplo: atualizar um registro em uma entidade

Este exemplo atualiza um registro na entidade DataModels.

  1. Na caixa de diálogo Configure connector task, clique em Entities.
  2. Selecione DataModels na lista de Entity.
  3. Selecione a operação Update e clique em Concluído.
  4. Na seção Task Input da tarefa Connectors, clique em connectorInputPayload e insira um valor semelhante ao seguinte no campo 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\":\"\"}"
    }
  5. Clique em entityId e, em seguida, insira /servicesNS/nobody/search/datamodel/model/Testing no campo Valor padrão.

    Se a integração for bem-sucedida, o campo connectorOutputPayload da tarefa do conector terá um valor semelhante a este:

    [{
     "Id": "/servicesNS/nobody/search/datamodel/model/Testing"
     }]

Usar o Terraform para criar conexões

Use o recurso do Terraform (em inglês) para criar uma nova conexão.

Para saber como aplicar ou remover uma configuração do Terraform, consulte Comandos básicos do Terraform.

Confira um exemplo de modelo do Terraform para criar uma conexão em exemplo.

Ao criar essa conexão usando o Terraform, você precisa definir as seguintes variáveis no arquivo de configuração do Terraform:

Nome do parâmetro Tipo de dados Obrigatório Descrição
nível de detalhes STRING Falso O nível de detalhamento da conexão varia de 1 a 5. Um nível de detalhamento mais alto registra todos os detalhes da comunicação (solicitações,respostas e certificados SSL).
proxy_enabled BOOLEAN Falso Marque essa caixa de seleção para configurar um servidor proxy para a conexão.
proxy_auth_scheme ENUM Falso O tipo de autenticação a ser usado para autenticar o proxy ProxyServer. Valores aceitos: BASIC, DIGEST, NONE
proxy_user STRING Falso Um nome de usuário a ser usado para autenticação no proxy ProxyServer.
proxy_password SECRET Falso Uma senha a ser usada para autenticação no proxy ProxyServer.
proxy_ssltype ENUM Falso O tipo de SSL a ser usado na conexão com o proxy do ProxyServer. Os valores aceitos são: AUTO, ALWAYS, NEVER, SELECTED

Usar a conexão do Splunk em uma integração

Depois de criar a conexão, ela ficará disponível tanto na Apigee Integration quanto na Application Integration. Use a conexão em uma integração por meio da tarefa Conectores.

  • Para entender como criar e usar a tarefa Conectores na integração da Apigee, consulte Tarefa Conectores.
  • Para entender como criar e usar a tarefa de conectores na Application Integration, consulte Tarefa "Conectores".

Receber ajuda da comunidade do Google Cloud

Poste suas dúvidas e converse sobre esse conector na comunidade do Google Cloud em Fóruns do Cloud.

A seguir