API Stability Short-Term

The logCollectorMergedConfiguration() GraphQL query used to get a Log Collector merged configuration.

Related to this query are several other query fields: searchLogCollectorGroups() to search log collector configurations; getLogCollectorDetails() to get the LogCollector's details; and logCollectorConfiguration() to get the configuration for a LogCollector.

There is also the createLogCollectorConfiguration(), deleteLogCollectorConfiguration(), and other related mutation fields.

For information on LogScale Collector, see the Falcon LogScale Collector pages in the main documentation. See the Configure Falcon LogScale Collector section for details on configuring.

Syntax

graphql
logCollectorMergedConfiguration(
      configIds: [string]!
   ): LogCollectorMergedConfiguration!

For the input, you would enter within square-brackets a list of unique identifiers of Log Collector configurations that you want to merge. For the results, you can get the merged configuration and a list of problems that may occur from merging. See the Returned Datatype section for more on this.

Example

Below is an example using this query field:

Raw
graphql
query {
  logCollectorMergedConfiguration(configIds: ["abc123", "def456"])
  { problems{ path, summary, number } }
}
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" : "query {
  logCollectorMergedConfiguration(configIds: [\"abc123\", \"def456\"])
  { problems{ path, summary, number } }
}"
}
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" : "query {
  logCollectorMergedConfiguration(configIds: [\"abc123\", \"def456\"])
  { problems{ path, summary, number } }
}"
}
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" : "query { ^
  logCollectorMergedConfiguration(configIds: [\"abc123\", \"def456\"]) ^
  { problems{ path, summary, number } } ^
}" ^
} '
Windows Powershell and curl
powershell
curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "query {
  logCollectorMergedConfiguration(configIds: [\"abc123\", \"def456\"])
  { problems{ path, summary, number } }
}"
}'
    "$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 = "query {
  logCollectorMergedConfiguration(configIds: [\"abc123\", \"def456\"])
  { problems{ path, summary, number } }
}";
$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" : "query {
  logCollectorMergedConfiguration(configIds: [\"abc123\", \"def456\"])
  { problems{ path, summary, number } }
}"
}'''

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" : "query {
  logCollectorMergedConfiguration(configIds: [\"abc123\", \"def456\"])
  { problems{ path, summary, number } }
}"
}
);


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": {
    "logCollectorMergedConfiguration": [ {
      "problems": {
         "path": "over-here",
         "summary": "Not quite right",
         "number": "2" }, ... ]
  }
}

Returned Datatype

The returned datatype, you can get the merged configuration and a list of problems that may occur from merging. The table below lists the parameters related to this:

Table: LogCollectorMergedConfiguration

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: Sep 26, 2024
contentstringyes Short-TermThe type of log source for Log Collector.
problems[LogCollectorConfigurationProblemAtPath]yes Short-TermThe name of the log source for Log Collector See LogCollectorConfigurationProblemAtPath.