Actions

Difference between revisions of "Otelligence Center"

From Syntaro Help

(Logs and Information about Configs and Scheduled Task)
(Manually Start the Scheduled Task)
(One intermediate revision by the same user not shown)
Line 39: Line 39:
  
 
In addition, you will see a new task in the task scheduler with the name "Otelligence upload" was created. Here you can double-check if the correct service account user will be running the task as well.
 
In addition, you will see a new task in the task scheduler with the name "Otelligence upload" was created. Here you can double-check if the correct service account user will be running the task as well.
 +
|}
 +
 +
=== Manually Start the Scheduled Task ===
 +
With the installation of the Otelligence Connector, a scheduled task will be created which runs in a random time frame after midnight if not configured otherwise. We will describe the steps if you ever need to test your configuration or anything else that needs a manual start of this task.
 +
{| class="wikitable"
 +
|- style="vertical-align:top;"
 +
|[[File:Otelligence_ScheduledTask_001.png|none|thumb|300px]]
 +
| Because the Otelligence Connector runs with a separate service account that you created prior to the installation of the connector, you also have to start the task scheduler as the service account to properly control the scheduled task. The simplest way to do this is to press the shift-button while right-clicking on the task scheduler and select "run as different user".<br><br>
 +
Once you opened the task scheduler with your service account you will find the Otelligence scheduled task in the directory "Task Scheduler Library". If you ran the task scheduler with the correct user, you can now manually start the task "Otelligence upload".
 
|}
 
|}
  
Line 83: Line 92:
 
These two options should be present in every config-file. If this is not the case for your specific plugin, please consult the documentation of the plugin. <br><br>
 
These two options should be present in every config-file. If this is not the case for your specific plugin, please consult the documentation of the plugin. <br><br>
 
For both settings you have possible values in the comment behind the standard value which can be set accordingly to meet your demands.
 
For both settings you have possible values in the comment behind the standard value which can be set accordingly to meet your demands.
|}
 
=== Manually Start the Scheduled Task ===
 
With the installation of the Otelligence Connector, a scheduled task will be created which runs in a random time frame after midnight if not configured otherwise. We will describe the steps if you ever need to test your configuration or anything else that needs a manual start of this task.
 
{| class="wikitable"
 
|- style="vertical-align:top;"
 
|[[File:Otelligence_ScheduledTask_001.png|none|thumb|300px]]
 
| Because the Otelligence Connector runs with a separate service account that you created prior to the installation of the connector, you also have to start the task scheduler as the service account to control the scheduled task. The most simple way to do this is to press the shift-button while right-clicking on the task scheduler and select "run as different user".<br><br>
 
Once you opened the task scheduler with your service account you will find the Otelligence scheduled task in the directory "Task Scheduler Library". If you ran the task scheduler with the correct user, you can now manually start the task "Otelligence upload".
 
 
|}
 
|}
  
 
==Notifications==
 
==Notifications==

Revision as of 13:09, 12 July 2019

Overview

Dashboard

Plugins

Connectors

Installation

Windows Preparation

Otelligence Service Account 001.png
To ensure, that the connector works as it is supposed to, we have to prepare some steps prior to the installation of the connector itself. First of all, we have to create a service account for the connector to use. This service account will have basic user permissions with some small tweaks. Considering security, we advice you to not give this service account administrative rights on your system where you install the connector.

Best practice for the creation of this account is to mark him with the prefix "sa" so you can easily find the user in later stages or whilst troubleshooting in the future. For our example we use the username "sa_otelligence"

Otelligence Service Account 002.png
In the next step we have to allow the service account to run tasks in the task scheduler. For this he needs the right to "Log On As A Batch Job". This permission can be assigned in the local security policy (secpol.msc).

First, you will have to navigate to "Local Policies" -> "User Rights Assignments". Here you will find the policy "Log On As A Batch Job" where you can include your service account or service group depending on your installation.

This already completes the preparation for the installation of the Otelligence Connector.

Connector Installation

Otelligence Connector Download.png
To get started, we have to download the Otelligence Connector which can be found in the navigation pane of your Syntaro portal. Under the register "Configuration" you will find the "Connectors"-blade. From this blade you can directly download the .MSI-file you need.
Otelligence Connector Install 001.png
Now you can run the .MSI file. On the first prompt you will see, you will have to validate your service account user. This will not check, if your user has the necessary permissions to run tasks in the scheduler.

Please make sure you followed the previous Windows Preparation steps correctly and you surely added the user to the correct group. Afterwards you can install the program without further user interaction.

Otelligence Connector Install 002.png
To validate if the program was installed properly you can check your file explorer. The core data of the connector will be copied to the following location: "%Systemdrive%\Program Files\Syntaro Otelligence Connector\".

In addition, you will see a new task in the task scheduler with the name "Otelligence upload" was created. Here you can double-check if the correct service account user will be running the task as well.

Manually Start the Scheduled Task

With the installation of the Otelligence Connector, a scheduled task will be created which runs in a random time frame after midnight if not configured otherwise. We will describe the steps if you ever need to test your configuration or anything else that needs a manual start of this task.

Otelligence ScheduledTask 001.png
Because the Otelligence Connector runs with a separate service account that you created prior to the installation of the connector, you also have to start the task scheduler as the service account to properly control the scheduled task. The simplest way to do this is to press the shift-button while right-clicking on the task scheduler and select "run as different user".

Once you opened the task scheduler with your service account you will find the Otelligence scheduled task in the directory "Task Scheduler Library". If you ran the task scheduler with the correct user, you can now manually start the task "Otelligence upload".

Gathering and Configuring Logs

In this section you can find information on how to see log-files and other data that could be useful during the setup process or whilst troubleshooting a problem. Please note that it can vary where you find the specific logs as you can manually configure every plugin to log the way you prefer. The different options are as followed:

  • Console-LogFile
  • Console-WindowsEvent
  • LogFile-WindowsEvent
  • Console
  • LogFile
  • WindowsEvent
  • All

Please note that the connector itself is creating entries in the Windows Eventlog. If you activate the logging for WindowsEvent too be cautious as it can clutter your Event Log. Our recommendation is, that you leave it on the standard which is "LogFile" or "Console-LogFile" for most plugins.

Windows Eventlog

Otelligence Logs 001.png
The Syntaro Otelligence logs can be found under the following location. > Applications and Services Logs > SyntaroOtelligence.

If you also have the Syntaro AppManagement service running, be careful that you select the correct log. The log "Syntaro" logs the events of the AppManagement not Otelligence.

Otelligence Logs 002.png
In the logs itself you will find entries from the Otelligence Connector or Plugins if you configured them to log WindowsEvents.

With a standard configuration you will see an entry for each plugin that was processed and completed as well as the start and completion of the connector itself. If processes from the connector throw errors you will find them here as well.

Plugin Specific Logs

Otelligence Logs 003.png
Every Plugin has a separate LOG-file where it logs its information. You can configure each plugin to log on two different log-levels which are "verbose" or "normal". With the option "normal" you will just see debug-messages as with "verbose" additional verbose-messages will be available in the log.

The logs can be found in the following directory: %SYSTEMDRIVE%\ProgramData\Otelligence\Logs\%PLUGINNAME%\%PLUGINNAME%.log

Config Files

Otelligence Config 001.png
Every plugin creates a configuration file where you can control, what the plugin does. In this section we will only show you, how to control the logging behaviour of the plugin. For plugin-specific settings, please consult the documentation of the plugin itself. ADD LINK IN THE FUTURE

The configs can be found in the following directory: %SYSTEMDRIVE%\ProgramData\Otelligence\Config\%PLUGINNAME%\config.json

Otelligence Config 002.png
If you open the config.json file with your preferred editor you will see the header of the config-file. To change the logging behaviour we have to focus on these two settings:
  • LogLevel
  • LogOutputMode

These two options should be present in every config-file. If this is not the case for your specific plugin, please consult the documentation of the plugin.

For both settings you have possible values in the comment behind the standard value which can be set accordingly to meet your demands.

Notifications