Permalink
Browse files

Add syntax docs

  • Loading branch information...
thomashumio committed Jun 20, 2018
1 parent 5f450a1 commit f178d390ba6004fab69d7174693f7b19c111e302
Showing with 581 additions and 505 deletions.
  1. +5 −5 content/api/_index.md
  2. +1 −1 content/api/cluster-management-api.md
  3. +1 −1 content/appendix/faq.md
  4. +17 −0 content/concepts/_index.md
  5. +1 −1 content/{using-humio/data-sources.md → concepts/datasources.md}
  6. 0 content/{using-humio → concepts}/events.md
  7. 0 content/{using-humio → concepts}/live-queries.md
  8. 0 content/{using-humio → concepts}/queries.md
  9. 0 content/{using-humio → concepts}/repositories.md
  10. 0 content/{using-humio → concepts}/tags.md
  11. +1 −2 content/{using-humio → concepts}/the-sandbox.md
  12. +7 −8 content/{using-humio → concepts}/views.md
  13. +3 −3 content/configuration/_index.md
  14. +0 −256 content/configuration/authentication/_index.md
  15. +29 −0 content/configuration/authentication/auth-by-proxy.md
  16. +54 −0 content/configuration/authentication/auth0.md
  17. +58 −0 content/configuration/authentication/ldap.md
  18. +107 −0 content/configuration/authentication/oauth.md
  19. +28 −0 content/configuration/authentication/single-user.md
  20. 0 content/{using-humio → configuration}/user-management.md
  21. +0 −16 content/installation/authentication.md
  22. +1 −1 content/installation/bare-metal.md
  23. +0 −26 content/installation/file-limit.md
  24. +42 −0 content/installation/preparation.md
  25. +1 −0 content/integrations/api-clients/browser-javascript.md
  26. +1 −0 content/integrations/data-shippers/beats/metricbeat.md
  27. +1 −0 content/integrations/data-shippers/netflow.md
  28. +18 −6 content/integrations/data-shippers/rsyslog.md
  29. +1 −0 content/integrations/other/nginx.md
  30. +157 −138 content/language-syntax/_index.md
  31. +1 −1 content/parsers/build-in-parsers/corelight-json.md
  32. +0 −7 content/using-humio/_index.md
  33. +5 −4 layouts/shortcodes/integrations.html
  34. +2 −1 static/css/theme-humio.css
  35. +0 −8 static/integrations/ansible.md
  36. +1 −0 static/integrations/auth0.svg
  37. BIN static/integrations/javascript.png
  38. +4 −0 static/integrations/javascript.svg
  39. +1 −0 static/integrations/ldap.svg
  40. +1 −0 static/integrations/metricbeat.svg
  41. +1 −0 static/integrations/netflow.svg
  42. +1 −0 static/integrations/oauth.svg
  43. +1 −0 static/integrations/opsgenie.svg
  44. +2 −1 themes/hugo-theme-humio/layouts/partials/footer.html
  45. +27 −19 themes/hugo-theme-humio/layouts/partials/menu.html
@@ -6,10 +6,10 @@ weight: 900

Here are some quick links to get you started using Humio's API:

- [Authentication]({{< relref "api_tokens.md" >}})
- [Search API]({{< relref "search-api.md" >}})
- [Ingest API]({{< relref "ingest-api.md" >}})
- [GraphQL API Explorer]({{ ref "graphql.md#api-explorer" }})
- [Authentication]({{< ref "api_tokens.md" >}})
- [Search API]({{< ref "search-api.md" >}})
- [Ingest API]({{< ref "ingest-api.md" >}})
- [GraphQL API Explorer]({{< ref "graphql.md#api-explorer" >}})

Everything you can do in Humio's UI can be done through our HTTP API as well.
In fact, the UI is constructed using solely the public API.
@@ -18,7 +18,7 @@ In fact, the UI is constructed using solely the public API.
## REST and GraphQL

Humio has a mixture of GraphQL and REST endpoints. You can read about the
[motivation behind using GraphQL]({{< relref "graphql.md" >}}),
[motivation behind using GraphQL]({{< ref "graphql.md" >}}),
as well as an introduction to GraphQL if you are not familiar with the technology.

{{% notice info %}}
@@ -6,7 +6,7 @@ weight: 500
This page provides information about the HTTP API for managing
on-premises installations of Humio.

All requests require **root-level access**. See [API token for local root access]({{< relref "authentication.md#root-token" >}}).
All requests require **root-level access**. See [API token for local root access]({{< relref "root-access.md#root-token" >}}).

Note, this API is still very much _work-in-progress_.

@@ -6,7 +6,7 @@ weight: 7
### What happened to "Dataspaces"

"Repository" is the new term. What used to be a "dataspace" in Humio is
now a [Repository]({{< relref "using-humio/repositories.md" >}}).
now a [Repository]({{< ref "repositories.md" >}}).

The HTTP API includes the path `/api/v1/dataspaces/$REPOSITORY_NAME/` to be
compatible with existing clients.
@@ -0,0 +1,17 @@
---
title: "Concepts"
category_title: Overview
weight: 100
---

This section of the documentation contains a glossary for the different concepts
and terminology Humio uses.

_Here is a suggested reading order for some core concepts:_

1. [Repositories]({{< ref "repositories.md" >}})
1. [Views]({{< ref "views.md" >}})
1. [Events]({{< ref "events.md" >}})
1. [Queries]({{< ref "queries.md" >}})
1. [Live Queries]({{< ref "live-queries.md" >}})
1. [Tags]({{< ref "tags.md" >}})
@@ -1,5 +1,5 @@
---
title: Data Sources
title: Datasources
---

A Data Source is a set of [Events]({{< ref "events.md" >}}) that have the same [Tags]({{< ref "tags.md" >}}).
File renamed without changes.
@@ -1,6 +1,5 @@
---
title: The Sandbox
weight: 3
title: Sandbox
---
In Humio all users have a private [Repository]({{< relref "repositories.md" >}}) called __The Sandbox__.

@@ -1,6 +1,5 @@
---
title: Views
weight: 4
---

A view is a special kind of repository. In most respects a view is just like an ordinary repository.
@@ -15,7 +14,7 @@ and associated queries that filter or modify the data as it is read.
There are many use-cases for views and you can see
[a list of examples later on this page]({{< ref "#examples" >}}).

### Searching across multiple repositories
## Searching across multiple repositories

The main function of a view is joining data from other repositories
and allowing you to search across their data.
@@ -42,7 +41,7 @@ You can use `#repo` in conjunction with a `case`-statement to modify events
based on which repository they come from.
{{% /notice %}}

#### Filtering {#filtering}
### Filtering {#filtering}

By default views contain all data from their connected repositories.
This is not always what you want and that is why you can apply a filter to each connection.
@@ -91,7 +90,7 @@ repositories to the view and the
{{% function "groupBy" %}}-aggregation is executed on the joined events.</figcaption>
</figure>

### Example use-cases {#examples}
## Example use-cases {#examples}

Views are a powerful tool and you can achieve many things, like:

@@ -103,7 +102,7 @@ Views are a powerful tool and you can achieve many things, like:
Here are some examples of how you can use views to give you an
idea of their power.

#### A repository per service {#per-service}
### A repository per service {#per-service}

Say you have a micro-service setup and you store all logs from all applications
in a single repository, let's call it `acme-project`. It can
@@ -141,7 +140,7 @@ In this example we create three views that all draw their data from
a single repository. If you are using a free cloud account the
repository could be you [Sandbox]({{< relref "the-sandbox.md" >}})

#### Redacting sensitive information {#sensitive}
### Redacting sensitive information {#sensitive}

Your data may contain information that not everyone should have access to.
You can use a view to implement security restrictions and censoring.
@@ -155,7 +154,7 @@ filter expression:
|--------------------|----------------------------------------|
| `hospital-logs` | {{< query >}}socialSecurityNo := "REDACTED"{{< /query >}} |

#### Restricting access to a subset of a repository {#subset}
### Restricting access to a subset of a repository {#subset}

Say your system produces logs in several regions, but some of the people who
have search access should only be able to see logs for their respective region.
@@ -171,7 +170,7 @@ reach the user. in this case limiting access to logs Germany :
In this example we are dealing with two repositories.


#### Field Aliases
### Field Aliases

In the [previous example]({{< relref "#subset" >}}) we saw that two repositories
had the same information but in two different fields depending on your parsers and
@@ -95,16 +95,16 @@ to get the number of CPU cores.
## Configuring Authentication

Humio supports different ways of authentication users. Read more in the
dedicated [Authentication Documentation]({{< relref "authentication.md" >}}).
dedicated [Authentication Documentation]({{< ref "configuration/authentication/_index.md" >}}).

## Public URL {#public_url}

`PUBLIC_URL` is the URL where the Humio instance is reachable from a browser.
Leave out trailing slashes.

This property is only important if you plan to use
[OAuth Federated Login]({{< relref "authentication.md#oauth">}}),
[Auth0 Login]({{< relref "authentication.md#auth0">}}) or if you want to be able
[OAuth Federated Login]({{< ref "oauth.md">}}),
[Auth0 Login]({{< ref "auth0.md">}}) or if you want to be able
to have Alert Notifications have consistent links back to the Humio UI.

The URL might only be reachable behind a VPN but that is no problem, as the user's
Oops, something went wrong.

0 comments on commit f178d39

Please sign in to comment.