Improve documentation

[Res260]

Hey, I tried to use foundry-js in a foundry app and had lots of trouble understanding some things. Here are some suggestions on things to add to the documentation to improve adoption from developpers:

• Add an example on how to supply input for parameterized queries for Logscale. After a support ticket, I found that this is documented somewhere in the logscale documentation, but there should at least be an example here
• Add an example on how to supply an end time for a logscale query. I had to dig deep in the code to find that, not a nice experience.
• Clarify what can be done with logscale from the javascript vs what can be done with custom queries in a foundry app. I was under the impression that I could gather sensor data from the JS library. However, this is NOT the case, as support told me. More importantly, there is NO error message if you try to gather sensor data from JS, you just get a response with zero results, which pretty much gaslight you into thinking that it's your query that is wrong, which is not the case. Very frustrating.

Thanks!

[prvn]

Fair points @Res260. Will get these addressed as soon as possible. Thank you for feedback and keep it coming.

[karbica]

Hello @Res260! Thanks for reaching out and providing that important feedback.

For the first two bullet points (LogScale documentation, end time query parameter), could you provide the links to those? I'd like to capture these references so I can cross with our other teams. I'd really appreciate it.

As for the last bullet point, I'll cross with that product team to produce some content around what foundry-js and LogScale can provide in the context of this package.

Thanks again.

[Res260]

For the input parameters: https://library.humio.com/data-analysis-1.82/syntax-fields-user-input.html

For the end time parameter, here is what I wrote. It's been a while since I ran this so double-check that it works:

    return await falcon.logscale.query({
      search_query: `*`,
      search_query_args: {computerName: computer},
      start: "1h",
      end: "now"
    });