Skip to content

Commit

Permalink
Merge pull request #91 from bermetj/documents
Browse files Browse the repository at this point in the history 
Updated documentation for LogShark 4.1
  • Loading branch information
@bermetj
bermetj committed Nov 7, 2019
2 parents f0b33a1 + 8248e8a commit cdb79d5
Show file tree
Hide file tree
Showing 12 changed files with 565 additions and 285 deletions.
56 changes: 28 additions & 28 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,56 +1,56 @@
# Logshark
# LogShark
[![Community Supported](https://img.shields.io/badge/Support%20Level-Community%20Supported-457387.svg)](https://www.tableau.com/support-levels-it-and-developer-tools)

Logshark is a command line utility that you can run against Tableau Server logs to generate a set of workbooks that provide insights into system performance, content usage, and error conditions.
Logshark is a tool you can use to analyze and troubleshoot Tableau Server performance and activity. Logshark extracts data from Tableau Server and Tableau Desktop log files and builds workbooks that can help you identify and understand error conditions, performance bottlenecks, and background activity. Logshark works by running a set of targeted plugins that pull specific data out of the log files. Logshark builds a data source and provides Tableau workbooks which you can then use to analyze the log files in Tableau.

Some common use cases for Logshark include:
Some common use cases for LogShark include:
* Troubleshooting issue(s) that are recorded in the logs.
* Analyzing system metrics from log data.
* Self-solving problems in Tableau without the fear of exposing sensitive corporate information.
* Regularly validating Tableau Server application behavior against historical data when taking a new build or making a system change.

![Sample Apache Workbook Screenshot](/Logshark.CLI/Resources/SampleScreenshot.png)

# How do I set up Logshark?
# How do I set up LogShark?

[![Download Logshark](https://img.shields.io/badge/Download%20Logshark-Version%203.0.1-blue.svg)](https://github.com/tableau/Logshark/releases/download/3.0.1/Setup_Logshark_v3.0.1.exe)
[![Download LogShark for Win](https://img.shields.io/badge/Download%20Logshark-Version%203.0.1-blue.svg)](https://github.com/tableau/Logshark/releases/download/3.0.1/Setup_Logshark_v3.0.1.exe)

[![Setup Logshark](https://img.shields.io/badge/Setup%20Logshark-Installation%20and%20User%20Guide-lightgrey.svg)](https://tableau.github.io/Logshark/)
[![Download LogShark for macOS](https://img.shields.io/badge/Download%20Logshark-Version%203.0.1-blue.svg)](https://github.com/tableau/Logshark/releases/download/3.0.1/Setup_Logshark_v3.0.1.exe)

Logshark is deployed via a custom installer, which you can download from the [releases page](https://github.com/tableau/Logshark/releases/latest). The installer manages dependencies and also bundles MongoDB for ease of setup for new users. To get up and running, download the installer and then follow the instructions in the [installation guide](https://tableau.github.io/Logshark/) to configure it.
[![Setup LogShark](https://img.shields.io/badge/Setup%20Logshark-Installation%20and%20User%20Guide-lightgrey.svg)](https://tableau.github.io/Logshark/)

In the latest release of Logshark, the run outputs are saved as hyper extracts instead of using PostgreSQL. Not only does Logshark no longer need a dedicated PostgreSQL database, it also runs significantly faster. The results of the Logshark run are now saved as hyper extracts embedded with the workbook (.twbx), which enables the vizzes to load much faster.
No installer is needed for this version, as LogShark is provided as a self-contained application. Simply download a zip file with LogShark (see link above), navigate to a location where you want to install it, and unzip the file there.

Logshark requires a 64-bit version of Windows in order to run, and must be run as an account with administrator privileges.
This version of LogShark is significantly ***FASTER*** and brings back the ability to write to a PostgreSQL database server, as well as a number of other improvements. See [releases page](https://github.com/tableau/Logshark/releases/latest) for a full list of updates.

NOTE: If you are upgrading from a previous version of Logshark, the installer will handle most of the upgrade work for you, but during the upgrade your Logshark.config file will be overwritten. If there are settings from this config you wish to preserve, please make a backup.
# System Requirements

# How do I analyze results from Logshark?
**For Windows**:
- LogShark requires a 64-bit version of Windows in order to run, and must be run as an account with administrator privileges.
- Hyper API for C++. If Hyper requirements are not met on the machine, LogShark will fail. The simpest way to meet Hyper requirements is to install Tableau Desktop on your machine.
- If you don't have Tableau Desktop installed, you will need Visual C++ Redistributables. Download x64 version of "Visual Studio 2015, 2017 and 2019" package from https://support.microsoft.com/en-us/help/2977003/the-latest-supported-visual-c-downloads.

The best way to analyze results is to run Logshark on your own logset and explore the generated workbooks via Tableau! Beyond what is included, you can configure Logshark to output your own custom workbooks. See the [installation guide](https://tableau.github.io/Logshark/) for more details on how to do this.
**For macOS:**
- LogShark runs on macOS versions 10.12 "Sierra", 10.13 "High Sierra, and 10.14 "Mojave".
- Currently LogShark doesn't support macOS 10.15 "Catalina".

For the truly adventurous, Logshark features a plugin framework, so you can even build your own analysis plugin to leverage Logshark's log parsing engine!
NOTE: If you are copying over existing LogShark folder, make a backup copy of your config file to preserve any valuable settings you have previously set for LogShark.

# What do I need to build Logshark from source?
# How do I analyze results from LogShark?

The current development requirements are:
The best way to analyze results is to run LogShark on your own logset and explore the generated workbooks via Tableau. Beyond what is included, you can configure LogShark to output your own custom workbooks. See the [installation guide](https://tableau.github.io/Logshark/) for more details on how to do this.

1. Windows operating system. (64-bit)
2. Visual Studio 2015 or later.
3. WiX Toolset Visual Studio Extension v3.10.1 or later - Required if you wish to to modify the installer projects.
* Available at http://www.wixtoolset.org
4. Configuration Section Designer Visual Studio Extension - Required if you wish to modify & regenerate the "LogsharkConfigSection" custom config section class.
* Available at http://csd.codeplex.com
5. Download [hyperd.exe](https://github.com/tableau/Logshark/releases/download/v3.0/hyperd.exe) and [hyperd_sse2.exe](https://github.com/tableau/Logshark/releases/download/v3.0/hyperd_sse2.exe) and place them in .\Tableau.ExtractApi\lib\SDK\hyper\
# What do I need to build LogShark from source?

It is recommended that you install the Logshark Workbook Creation Plugin Project Template extension by running the "Logshark Workbook Creation Plugin Project Template.vsix" file found in the root directory. This adds a "Logshark Workbook Creation Plugin" project type to Visual Studio which you can use to easily get up and running developing a new plugin.
Instructions on how to build LogShark from the source code are coming soon.

Note that you do not need to build Logshark from source to use it; a pre-built installer is available on the [releases page](https://github.com/tableau/Logshark/releases/latest).
Please note that current source code is for Logshark 3.0. The source code for LogShark 4.0 will be released soon.

# Is Logshark supported?

Logshark is Community Supported. This is intended to be a self-service tool and includes a user guide. Any bugs discovered should be filed in the Logshark [Git issue tracker](https://github.com/tableau/Logshark/issues).
# Is LogShark supported?

# How can I contribute to Logshark?
LogShark is released as a [Community-Supported](https://www.tableau.com/support/itsupport) tool. It is intended to be a self-service tool and includes this user guide. Any bugs discovered should be filed in the LogShark [Git issue tracker](https://github.com/tableau/Logshark/issues).

Code contributions & improvements by the community are welcomed and encouraged! See the [LICENSE file](https://github.com/tableau/Logshark/blob/master/LICENSE) for current open-source licensing & use information. Before we can accept pull requests from contributors, we do require a Contributor License Agreement. See http://tableau.github.io/ for more details.
# How can I contribute to LogShark?

Code contributions & improvements by the community are welcomed and encouraged! See the [LICENSE file](https://github.com/tableau/Logshark/blob/master/LICENSE) for current open-source licensing & use information. Before we can accept pull requests from contributors, we do require a Contributor License Agreement. See http://tableau.github.io for more details.
20 changes: 10 additions & 10 deletions docs/_includes/docs_menu.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,32 +6,32 @@
<a href="{{ site.baseurl }}/docs">Logshark Installation and User Guide</a>
</li> -->
<li>
<a href="{{ site.baseurl }}/docs/logshark_prefunc">Get your computer set up for Logshark</a>
<a href="{{ site.baseurl }}/docs/logshark_prefunc">Get your computer set up for LogShark</a>
</li>
<li>
<a href="{{ site.baseurl }}/docs/logshark_install">Install and Configure Logshark</a>
<a href="{{ site.baseurl }}/docs/logshark_install">Install LogShark</a>
</li>

<li class="nav-header">Use Logshark</li>
<li>
<a href="{{ site.baseurl }}/docs/logshark_run">Run Logshark and View the Results</a>
<a href="{{ site.baseurl }}/docs/logshark_run">Run LogShark</a>
</li>

<li class="nav-header">Logshark Reference</li>
<li>
<a href="{{ site.baseurl }}/docs/logshark_cmds">Logshark Command Options</a>
<a href="{{ site.baseurl }}/docs/logshark_configure">Configure and Customize LogShark</a>
</li>
<li>
<a href="{{ site.baseurl }}/docs/logshark_plugins">Logshark Plugins and Generated Workbooks</a>
<a href="{{ site.baseurl }}/docs/logshark_server">Publish Results to Tableau Server</a>
</li>
<li>
<a href="{{ site.baseurl }}/docs/logshark_customwbk">Add Custom Workbooks</a>
<a href="{{ site.baseurl }}/docs/logshark_postgres">See Historic Trends or Output to PostgreSQL</a>
</li>

<li class="nav-header">Logshark Reference</li>
<li>
<a href="{{ site.baseurl }}/docs/logshark_mongo">Use your own MongoDB Instance</a>
<a href="{{ site.baseurl }}/docs/logshark_cmds">Logshark Command Options</a>
</li>
<li>
<a href="{{ site.baseurl }}/docs/logshark_remove">Uninstall Logshark</a>
<a href="{{ site.baseurl }}/docs/logshark_plugins">Logshark Plugins and Generated Workbooks</a>
</li>
</ul>
</div>
68 changes: 68 additions & 0 deletions docs/docs/logshark_catalina.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
---
title: If You Are On macOS Catalina 10.15
---

* TOC
{:toc}

Issue
-------------------

If you are running LogShark on macOS Catalina 10.15, following error message is displayed:

* **LOgShark** cannot be opened because the developer cannot be verified. macOS cannot verify that this app is free from malware.*


Resolution
----------
Grant permission to **LogShark** and **System.Private.CoreLib.dll** as follows:
1. Click **Cancel** to dismiss the warning dialog.
**Note:** Do not click Move to Trash.
1. Open the **Security & Privacy** pane in System Preferences.
1. At the bottom of the pane, the message "**LogShark** was blocked from use because it is not from an identified developer" is displayed. Click the **Allow Anyway** button.
1. Run **LogShark** again.
1. The warning message is displayed for a second time, but now an Open button displays. Click **Open**.
1. The warning message displays for a third time, this time referencing **System.Private.CoreLib.dll** and offering options to Move to Trash or Cancel. Click **Cancel**.
1. Go back to the **Security & Privacy** pane and click **Allow Anyway** for this library file.
1. Run **custactutil** again.
1. The warning message will be displayed for a fourth time. click the **Open** button.

System.Runtime.dll
netstandard.dll
System.ComponentModel.dll
System.Console.dll
System.IO.FileSystem.dll
System.Runtime.Extensions.dll
System.Linq.dll
System.ComponentModel.Annotation.dll
System.Collections.dll
System.Threading.dll
System.Runtime.InteropServices.dll
System.Text.Encoding.Extentions.dll
System.Private.Uri.dll
System.Threading.Tasks.dll
System.Threading.Thread.dll
System.Memory.dll
System.Buffers.dll
System.Linq.Expressions.dll
System.ComponentModel.TypeConverter.dll
System.ObjectModel.dll
System.Runtime.Numerics.dll
System.IO.dll
System.Globalization.dll
System.Text.Encoding.dll
System.Text.RegularExpressions.dll
System.Threading.Timer.dll
System.Collections.NonGeneric.dll
System.Collections.Concurrent.dll
System.Runtime.InteropServices.RuntimeInformation.dll
System.Collections.Specialized.dll
System.Drawing.Primitives.dll

-----
This behavior is related to a known issue with ID 953649 which is currently under investigation.
Apple has new requirements for software to run on macOS Catalina.

Additional Information
----------------------
If you clicked **Move to Trash** in response to one of the warning messages, open the trash can, control-click or right-click the needed file, and select **Put back**.
Loading

0 comments on commit cdb79d5

Please sign in to comment.