From dfbfdca175d42aa7991dde0340305a278055443f Mon Sep 17 00:00:00 2001
From: Eran Zeitoun Zeitoun <57022870+ezeitoun@users.noreply.github.com>
Date: Fri, 10 Nov 2023 00:51:55 -0500
Subject: [PATCH] Create README.md
---
README.md | 46 ++++++++++++++++++++++++++++++++++++++++++++++
1 file changed, 46 insertions(+)
create mode 100644 README.md
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..2bc4934
--- /dev/null
+++ b/README.md
@@ -0,0 +1,46 @@
+# Galaxy Logs Collector v1.02
+
+This PowerShell script is designed to simplify the process of gathering Galaxy Logs (both user and server-side) for troubleshooting purposes.
+
+Extract the provided ZIP file to a preferred location (placing the script on the local client machine is recommended).
+Once completed, you have two options: create a shortcut to the GLC.BAT file or run GLC Create (with Admin rights) to generate a shortcut on the Desktop, complete with a default hotkey (Ctrl + Shift + F12).
+If you opt for automatic creation, The following shortcut will be create on the desktop:
+
+
+You can either double-click the shortcut to execute the Galaxy Logs Collector or press Ctrl+Shift+F12 within the client (or any other location).
+A popup will appear, prompting for an incident report/description.
+
+In this window, users can input details about their activities when the issue occurred.
+Clicking "Save and Close" will collect the logs (including DMP generation or copying a Galaxy Client generated one) and close (kill) the Dalet Galaxy client.
+Alternatively, clicking "Save" will collect the logs (and generate a DMP file) without terminating the client. This option is suitable for freezes that typically resolve after a period.
+
+As of version 1.02, the script collects the following:
+ - Input User for Incident Report
+ - Generate or Copy DMP File (⚠️)
+ - Capture Galaxy Client Screenshot
+ - Gather Running Processes Information
+ - Collect System & Applications Event Logs
+ - Collect Galaxy Client Logs
+ - Collect Galaxy Servers Logs
+ - Gather Windows Environment Variables
+⚠️ To enable DMP support, Please download ProcDump (https://learn.microsoft.com/en-us/sysinternals/downloads/procdump) and extract it to the GLC location.
+(Galaxy Client Screenshot Capture Improvement, Server-side log collections by Laurnet Goetz (lgoetz@dalet.com)
+
+The script can be configure by modifying the following variables:
+- $strProcessName (default "DaletGalaxy"), If a different process (OneCutSA) is being used rather DaletGalaxy.
+- $strToolsPath (default "C:\GLC\"), Script location (and where ProcDump should be copied to!)
+- $strStoragePath (default "C:\GLC\Files\"), The location were all compressed archive of the collected data will be written.
+- $strWorkPath (default $env:TEMP + "\GLC\"), Temp files location (default would be %TEMP%\GLC)
+- $StrServersLogsXML (default "\\yourShare\LogsToCollect.xml"), XML file containing required server-side logs, If file doesnt exist, This step will skipped.
+- $BolClose (default $true), Configure if the "Save and Close" button will appear.
+- $IntHours (default 4), Galaxy Client log collection range (in hours).
+
+Server-side log collection:
+In this updated GLC version (1.02), it is now feasible to collect particular agent logs alongside the local logs of the host where the script is initiated.
+This is achieved through the configuration of an XML file that specifies the desired servers and agents for the log gathering process.
+We advise against the wholesale collection of logs from all agents on every machine, as it may have an adverse impact on network traffic.
+Instead, we recommend a targeted approach, focusing on specific strategic agents such as dbServers, DaletPlusServers, and NATServers, as these are commonly implicated in most issues requiring investigation.
+For additional logs from specific hosts, like BrioMediaAgents located within the studios, it is suggested to tailor the log gathering accordingly.
+(The SiteName, HostName, HostAlias and the agents name for the XML file (sample included in the repository), Can be obtain from the Dalet Remote Admin)
+⚠️ Windows users running the script should have Read rights to C:\ProgramData\Dalet\DaletLogs of each server. (access will be done via UNC)
+