What's New in the Documentation

  • The ability to copy a link to a given header or section has been added; hover over a header and click to copy a reference to the location.

  • The markup of items during search has been updated to match the markup in the core documentation.

  • New Documentation System

    We have launched the documentation system on a new platform that will enable us to provide a number of new benefits, including expanding the coverage and type of documentation, improvements to the search system, and more content and information on Integrations, Packages, Dashboards. You'll also see improvements to the release notes and the ability to search and filter on more areas of the documentation.

    Some differences between the old and new versions of the documentation:

    • There are no longer separate versions of the documentation; instead you will find a section of each page in the bottom right that indicates the availability of the functionality outlined on the page.

    • The page markup has been expanded significantly; more of the documentation will now be marked up with different styles.

    • More of the documentation will contain links and connections to relevant and corresponding pages.

    • The sidebar on the right will contain more information and links to other pages.

    • You can hover over specific terms and items to get a summary or description of that feature or functionality.

    Now we have the platform in place, we will start to expand and improve the content, links and information over the coming months.

  • We have added a new section to the documentation to help users learn how to write queries, including best practices, basic techniques, and example queries. See Writing Queries.

  • There is a new section that demonstrates the best practices and techniques for access data in repositories and views. See Searching for Data.

  • Documentation has been added, including sample queries and data structure, for the new Corelight Sample Repository Data repository available in Humio Community Edition.

  • The Log Shippers documentation has been cleaned and updated to provide better consistency and to update the configuration and examples to make it easier to use.

  • Documentation on the new array functions has been added to the documentation:

  • We have updated the Dashboards and Managing Dashboard Widgets sections of the documentation with detailed definitions of how to build and define your dashboards, and the configuration for individual widgets

  • A bug in the search system meant that some pages outside of the current search context (e.g. stable documentation) could get ignored in the search results; we now correctly show documentation that exists outside of the current context, highlighted to show it's origin

  • We've added details on enabling direct ingestion of Falcon Data Replicator (FDR) data into Humio

  • We identified an issue with searches where the display would 'snap back' to the top of the display in the event of a long search.

  • The sidebar for non-versioned section of the documentation has been updated to reflect the current section and we now have expandable/collapsible TOC entries within the reference section to make navigation easier

  • We've moved the following sections into our Reference Information section:

    These materials are not version specific, and also a key part of getting data into Humio and using it effectively.

  • We've updated the LogScale User Interface section of the manual, simplifying the main structure and moving materials out to topic specific pages

  • Details on how to configure the Session Management functionality in the Humio Community Edition has been added

  • Documentation for the Humio Launcher Script which provides a simpler, and more powerful method for running Humio Server has been added to the documentation

  • We now have a How to Read the Documentation to help you navigate and read the documentation

  • The Last updated date at the bottom of each page is now unique to each page, making it much easier for you to see when an individual page was last updated.

  • We've improved our Environment Variables page; we now have a separate page for each individual variable which will make them easier to find, and we'll work on expanding the links, connections and related environment variables in the different pages

  • Read about Humio and the log4j v2/"log4shell" vulnerability FAQ: How is LogScale Responding to the Log4j Log4Shell Vulnerability

  • The training and tutorial pages have been updated with new information and structure to support our Humio Community Edition (Getting Started Tutorial)

  • The Packages documentation has been rewritten as part of our expansion of our Package support

Other Changes

  • The issue of double-clicking on search results has been addressed. You should no longer have to double click, while still being able to continue to type and select search results.

  • We've simplified the structure, so that version specific documentation and the core documentation (Knowledge Base, Reference, Release Notes) are in separate directories and locations with no shared content

  • The Library has a brand new search system which now covers the whole of the documentation library. Search is available on every page in the header bar, and let's you search both the current and previous versions of the documentation. You can also report documents and searches that don't work for you so we can improve the documentation over time.

  • We've improved the Table of Contents and navigation in the documentation to make it easier to find your way around, with a consistent TOC on the left, and in page and related links on the right.

Visit the Knowledge Base.