Skip to content

Latest commit

 

History

History
119 lines (78 loc) · 5.28 KB

README.md

File metadata and controls

119 lines (78 loc) · 5.28 KB
Raw

One Identity open source projects are supported through One Identity GitHub issues and the One Identity Community. This includes all scripts, plugins, SDKs, modules, code snippets or other solutions. For assistance with any One Identity GitHub project, please raise a new Issue on the One Identity GitHub project page. You may also visit the One Identity Community to ask questions. Requests for assistance made through official One Identity Support will be referred back to GitHub and the One Identity Community forums where those requests can benefit all users.

Log Insights for One Identity Manager logs

CI GitHub release (latest by date including pre-releases)

Provide insights over the contents of One Identity Manager log files or log entries in Azure Application Insights.

LogInsights screen shot

Table of Contents
  1. About the project
  2. Getting started
  3. Usage
  4. Contributing
  5. License

About the project

Identity Manager log files or the equivalent entries in Azure AppInsights overwhelm the administrator with a "wall of text" where insights over the system behaviour are hidden. Goal of this tool is to provide an analysis frontend to get these insights without needing to know a query language or deeper knowledge over the internals of Identity Manager.

It supports log files in the standard logging format written by NLog, Jobservice log files, and logs pushed to Azure Application Insights over the NLog logger.

Getting started

To get a local copy up and running follow these simple steps.

Prerequisites

Download the .NET 8 SDK.

Building

  1. Clone the repo

    git clone https://github.com/OneIdentity/IdentityManager.LogInsights.git
cd IdentityManager.LogInsights

  2. Build the project

    dotnet build

  3. Run the program

     dotnet run --project LogInsights\LogInsights.csproj

Or open it in Visual Studio and run it from there.

Installation

Download a ZIP file from the Releases page, unzip it into a folder and run LogInsights.exe.

The program runs on all Windows versions supported by .NET 8.

Usage

Drag and drop log files or folders onto the tree on the left side or open logs from the File -> Load logs... dialog.

The frontend supports the following analyses:

  • detect time ranges of all logfiles to provide a time line for all of them
  • detect time gaps between messages, which shows possible deadlock situations
  • detect JobService process steps, their requests and responses which should be tied together, detect errors and warning results for process steps
  • detect One Identity Manager synchronization ad hoc and full sync processes, including start and finish events, types and target system names to provide an overview over overall activity
  • detect One Identity Manager synchronization information about involved connectors and their activity
  • detect One Identity Manager synchronization activity (e.g. loading of data from a specific target system)
  • detect One Identity Manager synchronization journal reports
  • detect database SQL commands and their duration, detecting SQL transactions and long running queries

Many of these analyses depend of deeper log levels, like Debug or on the Debug mode of the JobService.

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

Distributed under the One Identity - Open Source License. See LICENSE for more information.