testKafkaEventForwarderV2()

API Stability	`Long-Term`

The testKafkaEventForwarderV2() GraphQL mutation is used to test that a Kafka event forwarder can connect to the specified Kafka server and topic. This may create the topic on the broker if the Kafka broker is configured to create topics, automatically.

Syntax

Below is the syntax for the testKafkaEventForwarderV2() mutation field:

graphql

testKafkaEventForwarderV2(
      input: TestKafkaEventForwarder!
   ): TestResult!

Below is an example of how this mutation field might be used:

Show:

graphql

mutation {
  testKafkaEventForwarderV2( input: 
    { name: "react",
      properties: "bootstrap.servers=localhost:3456",
      description: "Kafkaesk Event",
      topic: "tester"
      } )
  { success }
}

shell

curl -v -X POST $YOUR_LOGSCALE_URL/graphql \
    -H "Authorization: Bearer $TOKEN" \
    -H "Content-Type: application/json" \
    -d @- << EOF
{"query" : "mutation {
  testKafkaEventForwarderV2( input: 
    { name: \"react\",
      properties: \"bootstrap.servers=localhost:3456\",
      description: \"Kafkaesk Event\",
      topic: \"tester\"
      } )
  { success }
}"
}
EOF

shell

curl -v -X POST $YOUR_LOGSCALE_URL/graphql \
    -H "Authorization: Bearer $TOKEN" \
    -H "Content-Type: application/json" \
    -d @- << EOF
{"query" : "mutation {
  testKafkaEventForwarderV2( input: 
    { name: \"react\",
      properties: \"bootstrap.servers=localhost:3456\",
      description: \"Kafkaesk Event\",
      topic: \"tester\"
      } )
  { success }
}"
}
EOF

shell

curl -v -X POST $YOUR_LOGSCALE_URL/graphql ^
    -H "Authorization: Bearer $TOKEN" ^
    -H "Content-Type: application/json" ^
    -d @'{"query" : "mutation { ^
  testKafkaEventForwarderV2( input:  ^
    { name: \"react\", ^
      properties: \"bootstrap.servers=localhost:3456\", ^
      description: \"Kafkaesk Event\", ^
      topic: \"tester\" ^
      } ) ^
  { success } ^
}" ^
} '

powershell

curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "mutation {
  testKafkaEventForwarderV2( input: 
    { name: \"react\",
      properties: \"bootstrap.servers=localhost:3456\",
      description: \"Kafkaesk Event\",
      topic: \"tester\"
      } )
  { success }
}"
}'
    "$YOUR_LOGSCALE_URL/graphql"

perl

#!/usr/bin/perl

use HTTP::Request;
use LWP;

my $INGEST_TOKEN = "TOKEN";

my $uri = '$YOUR_LOGSCALE_URL/graphql';

my $json = '{"query" : "mutation {
  testKafkaEventForwarderV2( input: 
    { name: \"react\",
      properties: \"bootstrap.servers=localhost:3456\",
      description: \"Kafkaesk Event\",
      topic: \"tester\"
      } )
  { success }
}"
}';
my $req = HTTP::Request->new("POST", $uri );

$req->header("Authorization" => "Bearer $TOKEN");
$req->header("Content-Type" => "application/json");

$req->content( $json );

my $lwp = LWP::UserAgent->new;

my $result = $lwp->request( $req );

print $result->{"_content"},"\n";

python

#! /usr/local/bin/python3

import requests

url = '$YOUR_LOGSCALE_URL/graphql'
mydata = r'''{"query" : "mutation {
  testKafkaEventForwarderV2( input: 
    { name: \"react\",
      properties: \"bootstrap.servers=localhost:3456\",
      description: \"Kafkaesk Event\",
      topic: \"tester\"
      } )
  { success }
}"
}'''

resp = requests.post(url,
                     data = mydata,
                     headers = {
   "Authorization" : "Bearer $TOKEN",
   "Content-Type" : "application/json"
}
)

print(resp.text)

javascript

const https = require('https');

const data = JSON.stringify(
    {"query" : "mutation {
  testKafkaEventForwarderV2( input: 
    { name: \"react\",
      properties: \"bootstrap.servers=localhost:3456\",
      description: \"Kafkaesk Event\",
      topic: \"tester\"
      } )
  { success }
}"
}
);


const options = {
  hostname: '$YOUR_LOGSCALE_URL/graphql',
  path: '/graphql',
  port: 443,
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'Content-Length': data.length,
    Authorization: 'BEARER ' + process.env.TOKEN,
    'User-Agent': 'Node',
  },
};

const req = https.request(options, (res) => {
  let data = '';
  console.log(`statusCode: ${res.statusCode}`);

  res.on('data', (d) => {
    data += d;
  });
  res.on('end', () => {
    console.log(JSON.parse(data).data);
  });
});

req.on('error', (error) => {
  console.error(error);
});

req.write(data);
req.end();

Given Datatypes

For TestKafkaEventForwarder, there are a few parameters. Below is a list of them along with a description of each:

Table: TestKafkaEventForwarder

Parameter	Type	Required	Default	Description
Some arguments may be required, as indicated in the Required column. For some fields, this column indicates that a result will always be returned for this column.
Table last updated: Mar 28, 2025
`description`	string	yes		The description of the event forwarder.
`enabled`	boolean		true	Whether the event forwarder is enabled.
`name`	string	yes		The name of the event forwarder.
`properties`	string	yes		The Kafka producer configuration used to forward events in the form of properties (x.y.z=abc). See Kafka Configuration.
`topic`	string	yes		The Kafka topic to where the events should be forwarded.

Returned Datatypes

The returned datatype, TestResult has two parameters. They're listed in the table below with descriptions of each:

Table: TestResult

Parameter	Type	Required	Stability	Description
Some arguments may be required, as indicated in the Required column. For some fields, this column indicates that a result will always be returned for this column.
Table last updated: Oct 3, 2024
`message`	string	yes	`Long-Term`	A message explaining the test result.
`success`	boolean	yes	`Long-Term`	True if the test was a success, false otherwise.

GraphQL Mutations

GraphQL API Stability

GraphQL Queries

GraphQL Datatypes