testFdrFeed()

API Stability	`Long-Term`

The testFdrFeed() GraphQL mutation is used to test an FDR feed.

Syntax

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

graphql

testFdrFeed(
      input: TestFdrFeed!
   ): TestFdrResult!

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

Show:

graphql

mutation {
  testFdrFeed(input: {repositoryName: "humio", feedId: "abc123"}) {
    ... on TestFdrSuccessResult {
      result
    }
    ... on TestFdrErrorResult {
      errors {
        __typename
        ... on TestFdrValidationError {
          fieldName
          message
        }
        ... on TestFdrRequestError {
          resourceName
          message
        }
      }
    }
  }
}

shell

curl -v -X POST $YOUR_LOGSCALE_URL/graphql \
    -H "Authorization: Bearer $TOKEN" \
    -H "Content-Type: application/json" \
    -d @- << EOF
{"query" : "mutation {
  testFdrFeed(input: {repositoryName: \"humio\", feedId: \"abc123\"}) {
    ... on TestFdrSuccessResult {
      result
    }
    ... on TestFdrErrorResult {
      errors {
        __typename
        ... on TestFdrValidationError {
          fieldName
          message
        }
        ... on TestFdrRequestError {
          resourceName
          message
        }
      }
    }
  }
}"
}
EOF

shell

curl -v -X POST $YOUR_LOGSCALE_URL/graphql \
    -H "Authorization: Bearer $TOKEN" \
    -H "Content-Type: application/json" \
    -d @- << EOF
{"query" : "mutation {
  testFdrFeed(input: {repositoryName: \"humio\", feedId: \"abc123\"}) {
    ... on TestFdrSuccessResult {
      result
    }
    ... on TestFdrErrorResult {
      errors {
        __typename
        ... on TestFdrValidationError {
          fieldName
          message
        }
        ... on TestFdrRequestError {
          resourceName
          message
        }
      }
    }
  }
}"
}
EOF

shell

curl -v -X POST $YOUR_LOGSCALE_URL/graphql ^
    -H "Authorization: Bearer $TOKEN" ^
    -H "Content-Type: application/json" ^
    -d @'{"query" : "mutation { ^
  testFdrFeed(input: {repositoryName: \"humio\", feedId: \"abc123\"}) { ^
    ... on TestFdrSuccessResult { ^
      result ^
    } ^
    ... on TestFdrErrorResult { ^
      errors { ^
        __typename ^
        ... on TestFdrValidationError { ^
          fieldName ^
          message ^
        } ^
        ... on TestFdrRequestError { ^
          resourceName ^
          message ^
        } ^
      } ^
    } ^
  } ^
}" ^
} '

powershell

curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "mutation {
  testFdrFeed(input: {repositoryName: \"humio\", feedId: \"abc123\"}) {
    ... on TestFdrSuccessResult {
      result
    }
    ... on TestFdrErrorResult {
      errors {
        __typename
        ... on TestFdrValidationError {
          fieldName
          message
        }
        ... on TestFdrRequestError {
          resourceName
          message
        }
      }
    }
  }
}"
}'
    "$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 {
  testFdrFeed(input: {repositoryName: \"humio\", feedId: \"abc123\"}) {
    ... on TestFdrSuccessResult {
      result
    }
    ... on TestFdrErrorResult {
      errors {
        __typename
        ... on TestFdrValidationError {
          fieldName
          message
        }
        ... on TestFdrRequestError {
          resourceName
          message
        }
      }
    }
  }
}"
}';
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 {
  testFdrFeed(input: {repositoryName: \"humio\", feedId: \"abc123\"}) {
    ... on TestFdrSuccessResult {
      result
    }
    ... on TestFdrErrorResult {
      errors {
        __typename
        ... on TestFdrValidationError {
          fieldName
          message
        }
        ... on TestFdrRequestError {
          resourceName
          message
        }
      }
    }
  }
}"
}'''

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 {
  testFdrFeed(input: {repositoryName: \"humio\", feedId: \"abc123\"}) {
    ... on TestFdrSuccessResult {
      result
    }
    ... on TestFdrErrorResult {
      errors {
        __typename
        ... on TestFdrValidationError {
          fieldName
          message
        }
        ... on TestFdrRequestError {
          resourceName
          message
        }
      }
    }
  }
}"
}
);


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 TestFdrFeed, there are a few parameters that may be given. Below is a list of them along with a description of each:

Table: TestFdrFeed

Parameter	Type	Required	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: Sep 20, 2024
`clientId`	string		AWS client id to use in FDR feed test. If not set, the 'clientId' of the existing FDR feed will be used.
`clientSecret`	string		AWS client secret to use in FDR feed test. If not set, the clientSecret of the existing FDR feed will be used.
`feedId`	string		The unique identifier of an existing FDR feed. If no ID is provided, the remaining input fields must be set.
`repositoryName`	string	yes	The name of the repository of the FDR feed.
`s3Identifier`	string		AWS S3 identifier to use in FDR feed test. If not set, the s3Identifier of the existing FDR feed will be used.
`sqsUrl`	string		AWS SQS queue url to use in FDR feed test. If not set, the sqsUrl of the existing FDR feed will be used.

Returned Datatypes

The returned datatype, TestFdrResult is the output of running all the parser test cases, and a union of two other datatypes: TestFdrSuccessResult and TestFdrErrorResult. The parameters for those are listed in the tables below. See the example given above for a better understanding on how to enter these parameters.

Table: TestFdrSuccessResult

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
`result`	boolean	yes	`Long-Term`	The result of the test. It's always 'true'.

Table: TestFdrErrorResult

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
`errors`	[error]	yes	`Long-Term`	List of test errors. See also `TestFdrSuccessResult`.

GraphQL Mutations

GraphQL API Stability

GraphQL Queries

GraphQL Datatypes

testFdrFeed()

Syntax

Given Datatypes

Returned Datatypes

Enter search term