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

graphql
testKafkaEventForwarderV2(
      input: TestKafkaEventForwarder!
   ): TestResult!

For the input, you'll have to provide several parameters and values related to the Kafka event forwarder you want to test. to test. See the Given Datatype for more details.

Example

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

Raw
graphql
mutation {
  testKafkaEventForwarderV2( input: 
    { name: "react",
      properties: "bootstrap.servers=localhost:3456",
      description: "Kafkaesk Event",
      topic: "tester"
      } )
  { success }
}
Mac OS or Linux (curl)
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
Mac OS or Linux (curl) One-line
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
Windows Cmd and curl
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 } ^
}" ^
} '
Windows Powershell and curl
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
perl
#!/usr/bin/perl

use HTTP::Request;
use LWP;

my $TOKEN = "TOKEN";

my $uri = '$YOUR_LOGSCALE_URL/graphql';

my $query = "mutation {
  testKafkaEventForwarderV2( input: 
    { name: \"react\",
      properties: \"bootstrap.servers=localhost:3456\",
      description: \"Kafkaesk Event\",
      topic: \"tester\"
      } )
  { success }
}";
$query =~ s/\n/ /g;
my $json = sprintf('{"query" : "%s"}',$query);
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
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)
Node.js
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',
  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();
Example Responses
Success (HTTP Response Code 200 OK)
json
{
  "data": {
    "testKafkaEventForwarderV2": {
      "success": true
    }
  }
}

Given Datatype

For this input datatype, you would provide the name of the event forwarder to test, the Kafka topic on which to forward, and other parameters. These are listed and explained in the table below:

Table: TestKafkaEventForwarder

ParameterTypeRequiredDefaultStabilityDescription
Some arguments may be required, as indicated in the Required column. For return datatypes, this indicates that you must specify which fields you want returned in the results.
Table last updated: Mar 28, 2025
descriptionstringyes Long-TermThe description of the event forwarder.
enabledboolean trueLong-TermWhether the event forwarder is enabled.
namestringyes Long-TermThe name of the event forwarder.
propertiesstringyes Long-TermThe Kafka producer configuration used to forward events in the form of properties (x.y.z=abc). See Kafka Configuration.
topicstringyes Long-TermThe Kafka topic to where the events should be forwarded.

Returned Datatype

The returned datatype will tell you if the test was succesful and it will provide a message explaining results. This is described in the table below:

Table: TestResult

ParameterTypeRequiredDefaultStabilityDescription
Some arguments may be required, as indicated in the Required column. For return datatypes, this indicates that you must specify which fields you want returned in the results.
Table last updated: Oct 3, 2024
messagestringyes Long-TermA message explaining the test result.
successbooleanyes Long-TermTrue if the test was a success, false otherwise.