Splunk

O conetor do Splunk permite-lhe realizar operações de inserção, eliminação, atualização e leitura na base de dados do Splunk.

Antes de começar

Antes de usar o conetor do Splunk, conclua as seguintes tarefas:

  • No seu projeto do Google Cloud:
    • Certifique-se de que a conetividade de rede está configurada. Para obter informações sobre padrões de rede, consulte o artigo Conetividade de rede.
    • Conceda a função IAM roles/connectors.admin ao utilizador que está a configurar o conetor.
    • Conceda as seguintes funções de IAM à conta de serviço que quer usar para o conector:
      • roles/secretmanager.viewer
      • roles/secretmanager.secretAccessor

      Uma conta de serviço é um tipo especial de Conta Google destinada a representar um utilizador não humano que precisa de autenticação e autorização para aceder a dados nas APIs Google. Se não tiver uma conta de serviço, tem de criar uma. O conector e a conta de serviço têm de pertencer ao mesmo projeto. Para mais informações, consulte Criar uma conta de serviço.

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

      Para saber como ativar serviços, consulte o artigo Ativar serviços.

    Se estes serviços ou autorizações não tiverem sido ativados anteriormente para o seu projeto, é-lhe pedido que os ative quando configurar o conector.

Configure o conetor

Uma associação é específica de uma origem de dados. Isto significa que, se tiver muitas origens de dados, tem de criar uma associação separada para cada origem de dados. Para criar uma associação, faça o seguinte:

  1. Na Cloud Console, aceda à página Integration Connectors > Ligações e, de seguida, selecione ou crie um projeto do Google Cloud.

    Aceda à página Ligações

  2. Clique em + CRIAR NOVO para abrir a página Criar associação.
  3. Na secção Localização, escolha a localização para a ligação.
    1. Região: selecione uma localização na lista pendente.

      Para ver a lista de todas as regiões suportadas, consulte o artigo Localizações.

    2. Clique em SEGUINTE.
  4. Na secção Detalhes da associação, conclua o seguinte:
    1. Conetor: selecione Splunk na lista pendente de conetores disponíveis.
    2. Versão do conetor: selecione a versão do conetor na lista pendente de versões disponíveis.
    3. No campo Nome da ligação, introduza um nome para a instância de ligação.

      Os nomes das associações têm de cumprir os seguintes critérios:

      • Os nomes das associações podem usar letras, números ou hífenes.
      • As letras têm de ser minúsculas.
      • Os nomes das associações têm de começar com uma letra e terminar com uma letra ou um número.
      • Os nomes das associações não podem exceder 49 carateres.
    4. Opcionalmente, introduza uma Descrição para a instância de associação.
    5. Opcionalmente, ative o Registo na nuvem e, em seguida, selecione um nível de registo. Por predefinição, o nível do registo está definido como Error.
    6. Conta de serviço: selecione uma conta de serviço que tenha as funções necessárias.
    7. Opcionalmente, configure as definições do nó de associação:

      • Número mínimo de nós: introduza o número mínimo de nós de ligação.
      • Número máximo de nós: introduza o número máximo de nós de ligação.

      Um nó é uma unidade (ou uma réplica) de uma ligação que processa transações. São necessários mais nós para processar mais transações para uma ligação e, inversamente, são necessários menos nós para processar menos transações. Para compreender como os nós afetam os preços dos conectores, consulte o artigo Preços dos nós de ligação. Se não introduzir valores, por predefinição, os nós mínimos são definidos como 2 (para uma melhor disponibilidade) e os nós máximos são definidos como 50.

    8. Opcionalmente, clique em + ADICIONAR ETIQUETA para adicionar uma etiqueta à associação sob a forma de um par chave/valor.
    9. Clique em SEGUINTE.
  5. Na secção Destinos, introduza os detalhes do anfitrião remoto (sistema de back-end) ao qual quer estabelecer ligação.
    1. Tipo de destino: selecione um Tipo de destino.
      • Para especificar o nome de anfitrião ou o endereço IP de destino, selecione Endereço do anfitrião e introduza o endereço no campo Anfitrião 1.
      • Para estabelecer uma ligação privada, selecione Anexo do ponto final e escolha o anexo necessário na lista Anexo do ponto final.

      Se quiser estabelecer uma ligação pública aos seus sistemas de back-end com segurança adicional, pode considerar configurar endereços IP estáticos de saída para as suas ligações e, em seguida, configurar as regras da firewall para permitir apenas os endereços IP estáticos específicos.

      Para introduzir destinos adicionais, clique em +ADICIONAR DESTINO.

    2. Clique em SEGUINTE.
  6. Na secção Autenticação, introduza os detalhes de autenticação.
    1. Selecione um Tipo de autenticação e introduza os detalhes relevantes.

      Os seguintes tipos de autenticação são suportados pela ligação Splunk:

      • Nome de utilizador e palavra-passe (autenticação básica)
      • AccessToken
      • HTTPEventCollectorToken

      2. Para saber como configurar estes tipos de autenticação, consulte o artigo Configurar autenticação.

    2. Clique em SEGUINTE.
  7. Rever: reveja os detalhes da ligação e da autenticação.
  8. Clique em Criar.

Configure a autenticação

Introduza os detalhes com base na autenticação que quer usar.

  • Nome de utilizador e palavra-passe
    • Nome de utilizador: o nome de utilizador do Splunk a usar para a ligação.
    • Palavra-passe: Secret do Secret Manager que contém a palavra-passe associada ao nome de utilizador do Splunk.
  • AccessToken: defina esta opção para fazer a autenticação baseada em tokens através da propriedade AccessToken.
  • HTTPEventCollectorToken: defina esta opção para fazer a autenticação baseada em tokens através da propriedade HTTPEventCollectorToken.

Exemplos de configuração de ligação

Esta secção apresenta os valores de exemplo para os vários campos que configura quando cria a ligação ao Splunk.

Tipo de ligação do coletor de eventos de HTTP

Nome do campo Detalhes
Localização us-central1
Conetor Splunk
Versão do conetor 1
Nome da ligação splunk-http-event-coll-conn
Ative o Cloud Logging Não
Conta de serviço SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com
Número mínimo de nós 2
Número máximo de nós 50
Ativar SSL Sim
Ligação insegura do repositório fidedigno Sim
Tipo de destino(servidor) Morada do anfitrião
Morada do anfitrião 192.0.2.0
Porta PORT
Autenticação baseada em tokens do Colector de eventos de HTTP Sim
HTTPEventCollectorToken HTTPEVENTCOLLECTOR_TOKEN
Versão do Secret 1

Para obter informações sobre como criar um token do coletor de eventos HTTP, consulte o artigo Crie um coletor de eventos HTTP.

Tipo de ligação SSL

Nome do campo Detalhes
Localização us-central1
Conetor Splunk
Versão do conetor 1
Nome da ligação splunk-ssl-connection
Ative o Cloud Logging Sim
Conta de serviço SERVICE_ACCOUNT_NAME@PROJECT_ID.iam.gserviceaccount.com
Nível de verbosidade 5
Número mínimo de nós 2
Número máximo de nós 50
Ativar SSL Sim
Ligação insegura Sim
Tipo de destino(servidor) Morada do anfitrião
Morada do anfitrião https://192.0.2.0
Porta PORT
Palavra-passe do utilizador Sim
Nome de utilizador UTILIZADOR
Palavra-passe PASSWORD
Versão do Secret 1

Para a autenticação básica, tem de ter a função de utilizador ou a função de utilizador avançado. Para obter informações sobre como configurar um utilizador avançado, consulte o artigo Configure a função de utilizador avançado. Para obter informações sobre a definição de funções no Splunk, consulte o artigo Defina a função na plataforma Splunk.

Entidades, operações e ações

Todos os conetores de integração oferecem uma camada de abstração para os objetos da aplicação ligada. Só pode aceder aos objetos de uma aplicação através desta abstração. A abstração é exposta como entidades, operações e ações.

  • Entidade: pode considerar uma entidade como um objeto ou uma coleção de propriedades na aplicação ou no serviço associado. A definição de uma entidade difere de um conetor para um conetor. Por exemplo, num conetor de base de dados, as tabelas são as entidades. Num conetor de servidor de ficheiros, as pastas são as entidades. Num conetor de sistema de mensagens, as filas são as entidades.

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

  • Operação: uma operação é a atividade que pode realizar numa entidade. Pode realizar qualquer uma das seguintes operações numa entidade:

    Selecionar uma entidade na lista disponível gera uma lista de operações disponíveis para a entidade. Para uma descrição detalhada das operações, consulte as operações de entidades da tarefa de conectores. No entanto, se um conector não suportar nenhuma das operações de entidades, essas operações não suportadas não são apresentadas na lista Operations.

  • Ação: uma ação é uma função de primeira classe que é disponibilizada à integração através da interface do conetor. Uma ação permite-lhe fazer alterações a uma ou mais entidades e varia de conetor para conetor. Normalmente, uma ação tem alguns parâmetros de entrada e um parâmetro de saída. No entanto, é possível que um conector não suporte nenhuma ação, caso em que a lista Actions está vazia.

Limitações do sistema

O conector do Splunk pode processar 5 transações por segundo, por nó, e limita todas as transações que excedam este limite. No entanto, o número de transações que este conector pode processar também depende das restrições impostas pela instância do Splunk. Por predefinição, os Integration Connectors atribuem 2 nós (para uma melhor disponibilidade) a uma ligação.

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

Ações

Esta secção apresenta as ações suportadas pelo conetor. Para compreender como configurar as ações, consulte os exemplos de ações.

Ação CreateHTTPEvent

Esta ação permite-lhe enviar dados e eventos de aplicações para uma implementação do Splunk através dos protocolos HTTP e HTTPS.

Parâmetros de entrada da ação CreateHTTPEvent

Nome do parâmetro Tipo de dados Obrigatória Descrição
EventContent String Sim O nome da tabela ou da vista.
ContentType String Não O tipo de conteúdo especificado para a entrada EventContent. Os valores suportados são JSON e RAWTEXT.
ChannelGUID Número inteiro Não O GUID do canal usado para o evento. Tem de especificar este valor se o elemento ContentType for RAWTEXT.

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

Esta ação devolve o estado de êxito do evento criado.

Ação CreateIndex

Esta ação permite-lhe criar índices.

Parâmetros de entrada da ação CreateIndex

Nome do parâmetro Tipo de dados Obrigatória Descrição
MaxMetaEntries String Não Define o número máximo de linhas únicas em ficheiros .data num contentor, 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 são transferidos para o estado congelado. A predefinição é 188697600 (6 anos).
HomePath String Não Um caminho absoluto que contém os contentores ativos e inativos para o índice.
MinRawFileSyncSecs String Não Especifique um número inteiro (ou disable) para este parâmetro. Este parâmetro define a frequência com que o splunkd força uma sincronização do sistema de ficheiros durante a compressão de fatias do registo.
ProcessTrackerServiceInterval String Não Especifica, em segundos, a frequência com que o indexador verifica o estado dos processos do SO secundário que iniciou para ver se pode iniciar novos processos para pedidos em fila. Se estiver definido como 0, o indexador verifica o estado do processo secundário a cada segundo.
ServiceMetaPeriod String Não Define a frequência (em segundos) com que os metadados são sincronizados com o disco.
MaxHotSpanSecs String Não Limite superior do intervalo máximo de tempo (em segundos) de contentores ativos ou recentes.
QuarantinePastSecs String Não Os eventos com a data/hora de quarantinePastSecs anterior a >now são colocados no contentor 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 ficheiros colddb para o índice. O caminho tem de ser legível e gravável.
MaxHotIdleSecs String Não Tempo de vida máximo, em segundos, de um bucket ativo
WarmToColdScript String Não Caminho para um script a executar quando move dados de quente para frio.
ColdToFrozenScript String Não Caminho para o script de arquivo.
MaxHotBuckets String Não Número máximo de hot buckets que podem existir por índice.
TstatsHomePath String Não Localização para armazenar dados TSIDX de aceleração do modelo de dados para este índice. Se for especificado, tem de ser definido em termos de uma definição de volume. O caminho tem de ser gravável
RepFactor String Não Controlo da replicação do índice. Este parâmetro aplica-se apenas a nós pares no cluster.
  • auto: use o valor de configuração da replicação do índice principal.
  • 0: desativa a replicação para este índice.
MaxDataSize String Não O tamanho máximo em MB que uma base de dados ativa pode atingir antes de ser acionada uma mudança para base de dados inativa. A especificação de auto ou auto_high_volume faz com que o Splunk ajuste automaticamente este parâmetro (recomendado).
MaxBloomBackfillBucketAge String Não Os valores válidos são: integer[m|s|h|d] se um contentor de acesso frequente ou infrequente for mais antigo do que a idade especificada, não crie nem reconstrua o respetivo filtro de Bloom. Especifique 0 para nunca reconstruir os filtros de Bloom.
BlockSignSize String Não Controla quantos eventos compõem um bloco para assinaturas de blocos. Se esta opção estiver definida como 0, a assinatura de blocos está desativada para este índice. O valor recomendado é 100.
Nome String Sim O nome do índice a criar
MaxTotalDataSizeMB String Não O tamanho máximo de um índice (em MB). Se um índice crescer mais do que o tamanho máximo, os dados mais antigos são congelados.
MaxWarmDBCount String Não O número máximo de contentores ativos. Se este número for excedido, os contentores ativos com o valor mais baixo para os respetivos tempos mais recentes são movidos para o estado inativo.
RawChunkSizeBytes String Não Tamanho não comprimido de destino em bytes para a fatia não processada individual no registo rawdata do índice. 0 não é um valor válido. Se for especificado 0, rawChunkSizeBytes é definido como o valor predefinido.
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 relação a um contentor 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, é chamada uma operação de sincronização antes de o descritor de ficheiros ser fechado nas atualizações de ficheiros de metadados. Esta funcionalidade melhora a integridade dos ficheiros de metadados, especialmente no que diz respeito a falhas do sistema operativo ou falhas da máquina.
RotatePeriodInSecs String Não Com que frequência (em segundos) deve verificar se é necessário criar um novo hot bucket. Além disso, com que frequência deve verificar se existem contentores quentes/frios que devem ser implementados/congelados.

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

Esta ação devolve uma mensagem de confirmação da ação CreateIndex.

Por exemplo, para saber como configurar a ação CreateIndex, consulte os exemplos de ações.

Ação CreateSavedSearch

Esta ação permite-lhe guardar as suas pesquisas

Introduza os parâmetros da ação CreateSavedSearch

Nome do parâmetro Tipo de dados Obrigatória Descrição
IsVisible Booleano Sim Indica se esta pesquisa guardada aparece na lista de pesquisas guardadas visíveis.
RealTimeSchedule Booleano Sim Se este valor for definido como 1, o programador baseia a respetiva determinação do próximo tempo de execução da pesquisa programada na hora atual. Se este valor for definido como 0, é determinado com base na hora de execução da última pesquisa.
Pesquisar String Sim A consulta de pesquisa a guardar
Descrição String Não Descrição desta pesquisa guardada
SchedulePriority String Sim Indica a prioridade de agendamento de uma pesquisa específica
CronSchedule String Sim O horário cron para executar esta pesquisa. Por exemplo, */5 * * * * faz com que a pesquisa seja executada a cada 5 minutos.
Nome String Sim Um nome para a pesquisa
UserContext String Sim Se for fornecido o contexto do utilizador, é usado o nó servicesNS (/servicesNS/[UserContext]/search). Caso contrário, é usado o ponto final geral, /services.
RunOnStartup Booleano Sim Indica se esta pesquisa é executada no arranque. Se não for executada no arranque, a pesquisa é executada na próxima hora agendada.
Desativado Booleano Não Indica se esta pesquisa guardada está desativada.
IsScheduled Booleano Sim Indica se esta pesquisa deve ser executada de acordo com um horário.

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

Esta ação devolve uma mensagem de confirmação da ação CreateSavedSearch.

Por exemplo, para saber como configurar a ação CreateSavedSearch, consulte os exemplos de ações.

Ação UpdateSavedSearch

Esta ação permite-lhe atualizar uma pesquisa guardada.

Parâmetros de entrada da ação UpdateSavedSearch

Nome do parâmetro Tipo de dados Obrigatória Descrição
IsVisible Booleano Sim Indica se esta pesquisa guardada aparece na lista de pesquisas guardadas visíveis.
RealTimeSchedule Booleano Sim Se este valor for definido como 1, o programador baseia a respetiva determinação do próximo tempo de execução da pesquisa programada na hora atual. Se este valor for definido como 0, é determinado com base no último tempo de execução da pesquisa.
Pesquisar String Sim A consulta de pesquisa a guardar
Descrição String Não Descrição desta pesquisa guardada
SchedulePriority String Sim Indica a prioridade de agendamento de uma pesquisa específica
CronSchedule String Sim O horário cron para executar esta pesquisa. Por exemplo, */5 * * * * faz com que a pesquisa seja executada a cada 5 minutos.
Nome String Sim Um nome para a pesquisa
UserContext String Sim Se for fornecido o contexto do utilizador, é usado o nó servicesNS (/servicesNS/[UserContext]/search). Caso contrário, é usado o ponto final geral, /services.
RunOnStartup Booleano Sim Indica se esta pesquisa é executada no arranque. Se não for executada no arranque, a pesquisa é executada na próxima hora agendada.
Desativado Booleano Não Indica se esta pesquisa guardada está desativada.
IsScheduled Booleano Sim Indica se esta pesquisa deve ser executada de acordo com um horário.

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

Esta ação devolve uma mensagem de confirmação da ação UpdateSavedSearch.

Por exemplo, para saber como configurar a ação UpdateSavedSearch, consulte os exemplos de ações.

Ação DeleteIndex

Esta ação permite-lhe eliminar um índice.

Introduza os parâmetros da ação DeleteIndex

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

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

Esta ação devolve uma mensagem de confirmação da ação DeleteIndex

Por exemplo, para saber como configurar a ação DeleteIndex, consulte os exemplos de ações.

Ação UpdateIndex

Esta ação permite-lhe atualizar um índice.

Parâmetros de entrada da ação UpdateIndex

Nome do parâmetro Tipo de dados Obrigatória Descrição
MaxMetaEntries String Não Define o número máximo de linhas únicas em ficheiros .data num contentor, 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 são transferidos para o estado congelado. A predefinição é 188697600 (6 anos).
HomePath String Não Um caminho absoluto que contém os contentores ativos e inativos para o índice.
MinRawFileSyncSecs String Não Especifique um número inteiro (ou disable) para este parâmetro. Este parâmetro define a frequência com que o splunkd força uma sincronização do sistema de ficheiros durante a compressão de fatias do registo.
ProcessTrackerServiceInterval String Não Especifica, em segundos, a frequência com que o indexador verifica o estado dos processos do SO secundário que iniciou para ver se pode iniciar novos processos para pedidos em fila. Se estiver definido como 0, o indexador verifica o estado do processo secundário a cada segundo.
ServiceMetaPeriod String Não Define a frequência (em segundos) com que os metadados são sincronizados com o disco.
MaxHotSpanSecs String Não Limite superior do intervalo máximo de tempo (em segundos) de contentores ativos ou recentes.
QuarantinePastSecs String Não Os eventos com a data/hora de quarantinePastSecs anterior a now são colocados no contentor 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 ficheiros colddb para o índice. O caminho tem de ser legível e gravável.
MaxHotIdleSecs String Não Tempo de vida máximo, em segundos, de um bucket ativo.
WarmToColdScript String Não Caminho para um script a executar quando move dados de quente para frio.
ColdToFrozenScript String Não Caminho para o script de arquivo.
MaxHotBuckets String Não Número máximo de hot buckets que podem existir por índice.
TstatsHomePath String Não Localização para armazenar dados TSIDX de aceleração do modelo de dados para este índice. Se especificado, tem de ser definido em termos de uma definição de volume. O caminho tem de ser gravável
RepFactor String Não Controlo da replicação do índice. Este parâmetro aplica-se apenas a nós pares no cluster.
  • auto: use o valor de configuração da replicação do índice principal.
  • 0: desativa a replicação para este índice.
MaxDataSize String Não O tamanho máximo em MB que uma base de dados ativa pode atingir antes de ser acionada uma mudança para base de dados inativa. A especificação de auto ou auto_high_volume faz com que o Splunk ajuste automaticamente este parâmetro (recomendado).
MaxBloomBackfillBucketAge String Não Os valores válidos são: integer[m|s|h|d] se um contentor de dados frequentes ou infrequentes for mais antigo do que a idade especificada, não crie nem reconstrua o respetivo filtro de Bloom. Especifique 0 para nunca reconstruir os filtros de Bloom.
BlockSignSize String Não Controla quantos eventos compõem um bloco para assinaturas de blocos. Se esta opção estiver definida como 0, a assinatura de blocos está desativada para este índice. O valor recomendado é 100.
Nome String Sim O nome do índice a criar
MaxTotalDataSizeMB String Sim O tamanho máximo de um índice (em MB). Se um índice crescer mais do que o tamanho máximo, os dados mais antigos são congelados.
MaxWarmDBCount String Não O número máximo de contentores ativos. Se este número for excedido, os contentores ativos com o valor mais baixo para os respetivos tempos mais recentes são movidos para o estado inativo.
RawChunkSizeBytes String Não Tamanho não comprimido de destino em bytes para a fatia não processada individual no registo de dados não processados do índice. 0 não é um valor válido. Se for especificado 0, rawChunkSizeBytes é definido como o valor predefinido.
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 relação a um contentor 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, é chamada uma operação de sincronização antes de o descritor de ficheiros ser fechado nas atualizações de ficheiros de metadados. Esta funcionalidade melhora a integridade dos ficheiros de metadados, especialmente no que diz respeito a falhas do sistema operativo ou falhas da máquina.
RotatePeriodInSecs String Não Com que frequência (em segundos) deve verificar se é necessário criar um novo hot bucket. Além disso, a frequência com que deve verificar se existem grupos de utilizadores ativos ou inativos que devem ser implementados ou congelados.

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

Esta ação devolve uma mensagem de confirmação da ação UpdateIndex.

Por exemplo, para saber como configurar a ação UpdateIndex, consulte os exemplos de ações.

Exemplos de ações

Exemplo: crie um evento HTTP

Este exemplo cria um evento HTTP.

  1. Na caixa de diálogo Configure connector task, clique em Actions.
  2. Selecione a ação CreateHTTPEvent e, de seguida, clique em Concluído.
  3. Na secção Entrada da tarefa da tarefa Conetores, clique em connectorInputPayload e, de seguida, introduza 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 da tarefa terá um valor semelhante ao seguinte:CreateHTTPEventconnectorOutputPayload

    [{
"Success": "Success"
}]

Exemplo: crie um índice

Este exemplo cria um índice.

  1. Na caixa de diálogo Configure connector task, clique em Actions.
  2. Selecione a ação CreateIndex e, de seguida, clique em Concluído.
  3. Na secção Entrada da tarefa da tarefa Conetores, clique em connectorInputPayload e, de seguida, introduza 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 da tarefa terá um valor semelhante ao seguinte:CreateIndexconnectorOutputPayload

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

Exemplo: crie uma pesquisa guardada

Este exemplo cria uma pesquisa guardada.

  1. Na caixa de diálogo Configure connector task, clique em Actions.
  2. Selecione a ação CreateSavedSearch e, de seguida, clique em Concluído.
  3. Na secção Entrada da tarefa da tarefa Conetores, clique em connectorInputPayload e, de seguida, introduza 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 da tarefa terá um valor semelhante ao seguinte:CreateSavedSearchconnectorOutputPayload

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

Exemplo: atualize uma pesquisa guardada

Este exemplo atualiza uma pesquisa guardada.

  1. Na caixa de diálogo Configure connector task, clique em Actions.
  2. Selecione a ação UpdateSavedSearch e, de seguida, clique em Concluído.
  3. Na secção Entrada da tarefa da tarefa Conetores, clique em connectorInputPayload e, de seguida, introduza 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 da tarefa terá um valor semelhante ao seguinte:UpdateSavedSearchconnectorOutputPayload

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

Exemplo: elimine um índice

Este exemplo elimina um índice.

  1. Na caixa de diálogo Configure connector task, clique em Actions.
  2. Selecione a ação DeleteIndex e, de seguida, clique em Concluído.
  3. Na secção Entrada da tarefa da tarefa Conetores, clique em connectorInputPayload e, de seguida, introduza 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 da tarefa terá um valor semelhante ao seguinte:DeleteIndexconnectorOutputPayload

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

Exemplo: atualize 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, de seguida, clique em Concluído.
  3. Na secção Entrada da tarefa da tarefa Conetores, clique em connectorInputPayload e, de seguida, introduza 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 da tarefa terá um valor semelhante ao seguinte:UpdateIndexconnectorOutputPayload

    [{
"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ções de entidades

Esta secção mostra como realizar algumas das operações de entidades neste conector.

Exemplo: lista todos os registos

Este exemplo apresenta todos os registos na entidade SearchJobs.

  1. Na caixa de diálogo Configure connector task, clique em Entities.
  2. Selecione SearchJobs na lista Entity.
  3. Selecione a operação List e, de seguida, clique em Concluído.
  4. Opcionalmente, na secção Entrada de tarefas da tarefa Conetores, pode filtrar o conjunto de resultados especificando uma cláusula de filtro. Especifique sempre o valor da cláusula de filtro entre aspas simples (').

Exemplo: obter um registo de uma entidade

Este exemplo obtém um registo com o ID especificado da entidade SearchJobs.

  1. Na caixa de diálogo Configure connector task, clique em Entities.
  2. Selecione SearchJobs na lista Entity.
  3. Selecione a operação Get e, de seguida, clique em Concluído.
  4. Na secção Entrada de tarefas da tarefa Conetores, clique em EntityId e, de seguida, introduza 1698309163.1300 no campo Valor predefinido.

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

Exemplo: crie um registo numa entidade

Este exemplo cria um registo na entidade SearchJobs.

  1. Na caixa de diálogo Configure connector task, clique em Entities.
  2. Selecione SearchJobs na lista Entity.
  3. Selecione a operação Create e, de seguida, clique em Concluído.
  4. Na secção Mapeador de dados da tarefa Mapeamento de dados, clique em Open Data Mapping Editor e, de seguida, introduza um valor semelhante ao seguinte no campo Input Value e escolha EntityId/ConnectorInputPayload como variável local. 
    { 
"EventSearch": "search (index=\"antivirus_logs\") sourcetype=access_combined | rex  \"(?\\d{1,3}\\.\\d{1,3}\\.\\d{1,3}\\.\\d{1,3})\" | iplocation IP_address| table IP_address, City, Country" 
}

    Se a integração for bem-sucedida, o parâmetro de resposta da tarefa SearchJobsconnectorOutputPayload terá um valor semelhante ao seguinte:

    {
"Sid": "1699336785.1919"
}

Exemplo: crie um registo numa entidade

Este exemplo cria um registo na entidade DataModels.

  1. Na caixa de diálogo Configure connector task, clique em Entities.
  2. Selecione DataModels na lista Entity.
  3. Selecione a operação Create e, de seguida, clique em Concluído.
  4. Na secção Entrada da tarefa da tarefa Conetores, clique em connectorInputPayload e, de seguida, introduza 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 tem um valor semelhante ao seguinte:

    [{
"Id": "Test1"
}]

Exemplo: elimine um registo de uma entidade

Este exemplo elimina o registo com o ID especificado na entidade DataModels.

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

Exemplo: atualize um registo numa entidade

Este exemplo atualiza um registo na entidade DataModels.

  1. Na caixa de diálogo Configure connector task, clique em Entities.
  2. Selecione DataModels na lista Entity.
  3. Selecione a operação Update e, de seguida, clique em Concluído.
  4. Na secção Entrada da tarefa da tarefa Conetores, clique em connectorInputPayload e, de seguida, introduza 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, de seguida, introduza /servicesNS/nobody/search/datamodel/model/Testing no campo Valor predefinido.

    Se a integração for bem-sucedida, o campo connectorOutputPayload da tarefa do conector tem um valor semelhante ao seguinte:

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

Exemplo: fluxo de pesquisa com o índice

Esta secção apresenta todo o fluxo de pesquisa com um único índice e vários índices.

Crie uma pesquisa com um único índice

  1. Na caixa de diálogo Configure connector task, clique em Entities.
  2. Selecione SearchJobs na lista Entity.
  3. Selecione a operação Create e, de seguida, clique em Concluído.
  4. Na secção Mapeador de dados da tarefa Mapeamento de dados, clique em Open Data Mapping Editor e, de seguida, introduza um valor semelhante ao seguinte no campo Input Value e escolha EntityId/ConnectorInputPayload como variável local. 
    {
"EventSearch": "search (index=\"http_testing\" sourcetype=\"googlecloud-testing\") "
}

    Se a integração for bem-sucedida, o parâmetro de resposta da tarefa SearchJobsconnectorOutputPayload terá um valor semelhante ao seguinte:

    {
"Sid": "1726051471.76"
}

Operação de lista que usa o nome do índice usado na consulta de pesquisa

  1. Na caixa de diálogo Configure connector task, clique em Entities.
  2. Selecione Index Name na lista Entity.
  3. Selecione a operação List e, de seguida, clique em Concluído.
  4. Na secção Entrada de tarefas da tarefa Conectores, pode definir a filterClause, como Sid= "1726051471.76".

    5. Se a integração for bem-sucedida, o parâmetro de resposta da tarefa Index NameconnectorOutputPayload terá um valor semelhante ao seguinte:

    [{
  "_bkt": "http_testing~0~D043151E-5A2D-4FAB-8647-4D5DA2F288AF",
  "_cd": "00:04:00",
  "_eventtype_color": null,
  "_indextime": 1.720702012E9,
  "_kv": null,
  "_raw": "hi How r yo\nplease\nfind \nmy notes",
  "_serial": 0.0,
  "_si": "googlecloud-bcone-splunk-vm\nhttp_testing",
  "_sourcetype": "googlecloud-testing",
  "_time": "2024-07-11 12:46:52.0",
  "eventtype": null,
  "host": "googlecloud-bcone-splunk-vm",
  "index": "http_testing",
  "linecount": 4.0,
  "punct": null,
  "source": "Testing.txt",
  "sourcetype": "googlecloud-testing",
  "splunk_server": "googlecloud-bcone-splunk-vm",
  "splunk_server_group": null,
  "timestamp": null,
  "JobId": "1726051471.76"
}]

Crie uma pesquisa com vários índices

  1. Na caixa de diálogo Configure connector task, clique em Entities.
  2. Selecione SearchJobs na lista Entity.
  3. Selecione a operação Create e, de seguida, clique em Concluído.
  4. Na secção Mapeador de dados da tarefa Mapeamento de dados, clique em Open Data Mapping Editor e, de seguida, introduza um valor semelhante ao seguinte no campo Input Value e escolha EntityId/ConnectorInputPayload como variável local. 
    {
"EventSearch": "search (index=\"http_testing\" OR index= \"googlecloud-demo\" sourcetype=\"googlecloud-testing\"  OR sourcetype=\"Demo_Text\")"
}

    Se a integração for bem-sucedida, o parâmetro de resposta da tarefa SearchJobsconnectorOutputPayload terá um valor semelhante ao seguinte:

    {
"Sid": "1727261971.4007"
}

Operação de lista com o nome dos índices usado na consulta de pesquisa

  1. Na caixa de diálogo Configure connector task, clique em Entities.
  2. Selecione Index Name Nome na lista Entity.
  3. Selecione a operação List e, de seguida, clique em Concluído.
  4. Na secção Task Input da tarefa Connectors, pode definir a filterClause, como Sid= '1727261971.4007'.

    5. Se a integração for bem-sucedida, o parâmetro de resposta da tarefa IndexconnectorOutputPayload terá um valor semelhante ao seguinte:

     [{
  "_bkt": "googlecloud-demo~0~D043151E-5A2D-4FAB-8647-4D5DA2F288AF",
  "_cd": "00:04:00",
  "_eventtype_color": null,
  "_indextime": 1.727155516E9,
  "_kv": null,
  "_raw": "Hi team\nwe have a demo please plan accordingly\nwith Google team",
  "_serial": 0.0,
  "_si": "googlecloud-bcone-splunk-vm\ngooglecloud-demo",
  "_sourcetype": "Demo_Text",
  "_time": "2024-09-24 05:25:16.0",
  "eventtype": null,
  "host": "googlecloud-bcone-splunk-vm",
  "index": "googlecloud-demo",
  "linecount": 3.0,
  "punct": null,
  "source": "Splunk_Demo.txt",
  "sourcetype": "Demo_Text",
  "splunk_server": "googlecloud-bcone-splunk-vm",
  "splunk_server_group": null,
  "timestamp": null,
  "JobId": "1727261971.4007"
}, {
  "_bkt": "http_testing~0~D043151E-5A2D-4FAB-8647-4D5DA2F288AF",
  "_cd": "00:04:00",
  "_eventtype_color": null,
  "_indextime": 1.720702012E9,
  "_kv": null,
  "_raw": "hi How r yo\nplease\nfind \nmy notes",
  "_serial": 1.0,
  "_si": "googlecloud-bcone-splunk-vm\nhttp_testing",
  "_sourcetype": "googlecloud-testing",
  "_time": "2024-07-11 12:46:52.0",
  "eventtype": null,
  "host": "googlecloud-bcone-splunk-vm",
  "index": "http_testing",
  "linecount": 4.0,
  "punct": null,
  "source": "Testing.txt",
  "sourcetype": "googlecloud-testing",
  "splunk_server": "googlecloud-bcone-splunk-vm",
  "splunk_server_group": null,
  "timestamp": null,
  "JobId": "1727261971.4007"
}]

Exemplo: fluxo de pesquisa com ReadJobResults

Esta secção apresenta todos os fluxos de pesquisa que usam o índice único e vários índices suportados pela ligação do Splunk. Atualmente,o tamanho máximo da carga útil para resultados de registo suportados é de 150 MB.

Crie uma pesquisa com um único índice

  1. Na caixa de diálogo Configure connector task, clique em Entities.
  2. Selecione SearchJobs na lista Entity.
  3. Selecione a operação Create e, de seguida, clique em Concluído.
  4. Na secção Mapeador de dados da tarefa Mapeamento de dados, clique em Open Data Mapping Editor e, de seguida, introduza um valor semelhante ao seguinte no campo Input Value e escolha EntityId/ConnectorInputPayload como variável local. 
    {
"EventSearch": "search (index=\"http_testing\" sourcetype=\"googlecloud-testing\") "
}

    Este exemplo cria uma pesquisa. Se a integração for bem-sucedida, o parâmetro de resposta da tarefa terá um valor semelhante ao seguinte:SearchJobsconnectorOutputPayload

    {
"Sid": "1732775755.24612"
}

Para obter os resultados da pesquisa, execute a operação de criação na ação ReadJobResults. Para garantir que os resultados são filtrados com base no Sid, transmita o Sid como um parâmetro para a ação.

Obtenha registos de resultados através da ação ReadJobResults

  1. Na caixa de diálogo Configure connector task, clique em Actions.
  2. Selecione a ação ReadJobResults e, de seguida, clique em Concluído.
  3. Na secção Mapeador de dados da tarefa Mapeamento de dados, clique em Open Data Mapping Editor e, de seguida, introduza um valor semelhante ao seguinte no campo Input Value e escolha EntityId/ConnectorInputPayload como variável local. 
    {
"Sid": "1732775755.24612"
}
    4. Se a ação for bem-sucedida, o parâmetro de resposta da tarefa terá um valor semelhante ao seguinte:ReadJobResultsconnectorOutputPayload

    [{
"_bkt": "http_testing~0~D043151E-5A2D-4FAB-8647-4D5DA2F288AF",
"_cd": "0:4",
"_indextime": "1720702012",
"_raw": "hi How r yo\nplease\nfind \nmy notes",
"_serial": "1",
"_si": "googlecloud-bcone-splunk-vm\nhttp_testing",
"_sourcetype": "googlecloud-testing",
"_time": "2024-07-11T12:46:52.000+00:00",
"host": "googlecloud-bcone-splunk-vm",
"index": "http_testing",
"linecount": "4",
"source": "Testing.txt",
"sourcetype": "googlecloud-testing",
"splunk_server": "googlecloud-bcone-splunk-vm",
"jobid": "1732775755.24612",
"sid": "1732775755.24612"
}]

Crie uma pesquisa com vários índices

  1. Na caixa de diálogo Configure connector task, clique em Entities.
  2. Selecione SearchJobs na lista Entity.
  3. Selecione a operação Create e, de seguida, clique em Concluído.
  4. Na secção Mapeador de dados da tarefa Mapeamento de dados, clique em Open Data Mapping Editor e, de seguida, introduza um valor semelhante ao seguinte no campo Input Value e escolha EntityId/ConnectorInputPayload como variável local. 
    {
"EventSearch": "search (index=\"http_testing\" OR index= \"googlecloud-demo\" sourcetype=\"googlecloud-testing\"  OR sourcetype=\"Demo_Text\")"
}

    Se a integração for bem-sucedida, o parâmetro de resposta da tarefa SearchJobsconnectorOutputPayload terá um valor semelhante ao seguinte:

    {
"Sid": "1732776556.24634"
}

Para obter os resultados da pesquisa, execute a operação de criação na ação ReadJobResults. Para garantir que os resultados são filtrados com base no Sid, transmita o Sid como um parâmetro para a ação.

Resultados dos registos através da ação ReadJobResults

  1. Na caixa de diálogo Configure connector task, clique em Actions.
  2. Selecione a ação ReadJobResults e, de seguida, clique em Concluído.
  3. Na secção Mapeador de dados da tarefa Mapeamento de dados, clique em Open Data Mapping Editor e, de seguida, introduza um valor semelhante ao seguinte no campo Input Value e escolha EntityId/ConnectorInputPayload como variável local. 
    {
"Sid": "1732776556.24634"
}

    4. Se a ação for bem-sucedida, o parâmetro de resposta da tarefa terá um valor semelhante ao seguinte:ReadJobResultsconnectorOutputPayload

    [{
"_bkt": "googlecloud-demo~0~D043151E-5A2D-4FAB-8647-4D5DA2F288AF",
"_cd": "0:4",
"_indextime": "1727155516",
"_raw": "Hi team\nwe have a demo please plan accordingly\nwith Google team",
"_serial": "0",
"_si": "googlecloud-bcone-splunk-vm\googlecloud-demo",
"_sourcetype": "Demo_Text",
"_time": "2024-09-24T05:25:16.000+00:00",
"host": "googlecloud-bcone-splunk-vm",
"index": "googlecloud-demo",
"linecount": "3",
"source": "Splunk_Demo.txt",
"sourcetype": "Demo_Text",
"splunk_server": "googlecloud-bcone-splunk-vm",
"jobid": "1732776556.24634",
"sid": "1732776556.24634"
},{
"_bkt": "http_testing~0~D043151E-5A2D-4FAB-8647-4D5DA2F288AF",
"_cd": "0:4",
"_indextime": "1720702012",
"_raw": "hi How r yo\nplease\nfind \nmy notes",
"_serial": "1",
"_si": "googlecloud-bcone-splunk-vm\nhttp_testing",
"_sourcetype": "googlecloud-testing",
"_time": "2024-07-11T12:46:52.000+00:00",
"host": "googlecloud-bcone-splunk-vm",
"index": "http_testing",
"linecount": "4",
"source": "Testing.txt",
"sourcetype": "googlecloud-testing",
"splunk_server": "googlecloud-bcone-splunk-vm",
"jobid": "1732776556.24634",
"sid": "1732776556.24634"
}]

    Crie ligações com o Terraform

    Pode usar o recurso do Terraform para criar uma nova associação.

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

    Para ver um modelo do Terraform de exemplo para a criação de ligações, consulte o modelo de exemplo.

    Quando criar esta associação através do Terraform, tem de definir as seguintes variáveis no ficheiro de configuração do Terraform:

    Nome do parâmetro Tipo de dados Obrigatória Descrição
    verbosidade STRING Falso Nível de verbosidade para a ligação, varia de 1 a 5. Um nível de detalhe mais elevado regista todos os detalhes de comunicação (pedido,resposta e certificados SSL).
    proxy_enabled BOOLEAN Falso Selecione esta caixa de verificação para configurar um servidor proxy para a ligação.
    proxy_auth_scheme ENUM Falso O tipo de autenticação a usar para autenticar no proxy ProxyServer. Os valores suportados são: BASIC, DIGEST, NONE
    proxy_user STRING Falso Um nome de utilizador a ser usado para autenticar no proxy ProxyServer.
    proxy_password SECRET Falso Uma palavra-passe a usar para autenticar no proxy ProxyServer.
    proxy_ssltype ENUM Falso O tipo de SSL a usar quando se liga ao proxy ProxyServer. Os valores suportados são: AUTO, ALWAYS, NEVER, TUNNEL

    Use a ligação do Splunk numa integração

    Depois de criar a ligação, esta fica disponível no Apigee Integration e no Application Integration. Pode usar a ligação numa integração através da tarefa Conectores.

    • Para compreender como criar e usar a tarefa Connectors no Apigee Integration, consulte o artigo Tarefa Connectors.
    • Para compreender como criar e usar a tarefa Connectors na integração de aplicações, consulte o artigo Tarefa Connectors.

    Obtenha ajuda da comunidade do Google Cloud

    Pode publicar as suas perguntas e discutir este conector na comunidade do Google Cloud nos Fóruns do Cloud.

    O que se segue?