diff --git a/README.md b/README.md index 8277f78e4..f383c10cc 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,5 @@ # Operations Management Suite Agent for Linux Public Preview + ## Overview Welcome to the OMS Agent for Linux! The OMS Agent for Linux enables rich and real-time analytics for operational data (Syslog, Performance, Alerts, Inventory) from Linux servers, Docker Containers and monitoring tools like Nagios, Zabbix and System Center. @@ -12,12 +13,12 @@ $> wget https://github.com/MSFTOSSMgmt/OMS-Agent-for-Linux/releases/download/1.0 $> md5sum ./omsagent-1.0.0-47.universal.x64.sh $> sudo sh ./omsagent-1.0.0-47.universal.x64.sh --upgrade -w -s ``` -[Full installation guide](https://github.com/MSFTOSSMgmt/OMS-Agent-for-Linux/blob/master/docs/OMS-Agent-for-Linux.md#install-the-oms-agent-for-linux) +[Full installation guide](docs/OMS-Agent-for-Linux.md#install-the-oms-agent-for-linux) ### [Video Walkthrough](https://www.youtube.com/watch?v=7b4KxL7E5fw) -## [Download Latest OMS Agent for Linux (64-bit) ](https://github.com/MSFTOSSMgmt/OMS-Agent-for-Linux/releases/download/1.0.0-47/omsagent-1.0.0-47.universal.x64.sh) -## [Download Latest OMS Agent for Linux (32-bit ) ](https://github.com/MSFTOSSMgmt/OMS-Agent-for-Linux/releases/download/1.0.0-47/omsagent-1.0.0-47.universal.x86.sh) +## [Download Latest OMS Agent for Linux (64-bit)](releases/download/1.0.0-47/omsagent-1.0.0-47.universal.x64.sh) +## [Download Latest OMS Agent for Linux (32-bit)](releases/download/1.0.0-47/omsagent-1.0.0-47.universal.x86.sh) ## Feedback We love feedback! Whether it be good, bad or indifferent, it really helps us build a better product for you. There are a few different routes to give feedback: @@ -37,10 +38,10 @@ We love feedback! Whether it be good, bad or indifferent, it really helps us bu * SUSE Linux Enteprise Server 11 and 12 (x86/x64) ## Supported Scenarios -### [Syslog data collection](https://github.com/MSFTOSSMgmt/OMS-Agent-for-Linux/blob/master/docs/OMS-Agent-for-Linux.md#viewing-syslog-events) -### [Docker collection] (https://github.com/MSFTOSSMgmt/OMS-Agent-for-Linux/blob/master/docs/Docker-Instructions.md) -### [Performance data collection](https://github.com/MSFTOSSMgmt/OMS-Agent-for-Linux/blob/master/docs/OMS-Agent-for-Linux.md#viewing-performance-data) -### [Nagios Core alert collection](https://github.com/MSFTOSSMgmt/OMS-Agent-for-Linux/blob/master/docs/OMS-Agent-for-Linux.md#viewing-nagios-alerts) -### [Zabbix alert collection](https://github.com/MSFTOSSMgmt/OMS-Agent-for-Linux/blob/master/docs/OMS-Agent-for-Linux.md#viewing-zabbix-alerts) +### [Syslog data collection](docs/OMS-Agent-for-Linux.md#viewing-syslog-events) +### [Docker collection](docs/Docker-Instructions.md) +### [Performance data collection](docs/OMS-Agent-for-Linux.md#viewing-performance-data) +### [Nagios Core alert collection](docs/OMS-Agent-for-Linux.md#viewing-nagios-alerts) +### [Zabbix alert collection](docs/OMS-Agent-for-Linux.md#viewing-zabbix-alerts) -## [Full documentation](https://github.com/MSFTOSSMgmt/OMS-Agent-for-Linux/blob/master/docs/OMS-Agent-for-Linux.md) +## [Full documentation](docs/OMS-Agent-for-Linux.md) diff --git a/docs/Docker-Instructions.md b/docs/Docker-Instructions.md index 8834f5ce1..2b336677c 100644 --- a/docs/Docker-Instructions.md +++ b/docs/Docker-Instructions.md @@ -21,7 +21,7 @@ And one of: * CentOS 7 * SUSE Linux Enterprise Server 12 -You'll need to [install the OMS Agent for Linux] (https://github.com/MSFTOSSMgmt/OMS-Agent-for-Linux/blob/master/docs/OMS-Agent-for-Linux.md#steps-to-install-the-oms-agent-for-linux) on each host and then do the following to configure your containers to use the FluentD logging driver: +You'll need to [install the OMS Agent for Linux] (docs/OMS-Agent-for-Linux.md#steps-to-install-the-oms-agent-for-linux) on each host and then do the following to configure your containers to use the FluentD logging driver: * Edit `/etc/default/docker` and add this line: ``` @@ -39,7 +39,7 @@ Once you’re set up, we’d like you to try the following scenarios and play ar ### Overview Look at the Container top tile – it’s intended to show you a quick overview of the system. Does it contain the information you need to see first? If not, tell us what you expect to see instead. -![DockerOverviewTile](https://github.com/MSFTOSSMgmt/OMS-Agent-for-Linux/blob/master/docs/pictures/DockerPics/DockerOverviewTile.png?raw=true) +![DockerOverviewTile](pictures/DockerPics/DockerOverviewTile.png?raw=true) The top tile shows hosts that are overwhelmed with CPU or Memory usage (>90%), as well as an overview of how many containers you have in the environment and whether they’re failed, running, or stopped. @@ -52,11 +52,11 @@ Click the solution pack tile. From there you’ll see views organized by: The container solutions pack works by collecting various performance metrics and log data and sending it to the Operations Management Suite service. Each pane you see on the UI is a visual representation of a search that is run on this data. **Try it:** Click on the top tile of this pane. - ![DockerHostsPicture](https://github.com/MSFTOSSMgmt/OMS-Agent-for-Linux/blob/master/docs/pictures/DockerPics/DockerContainerHosts.png?raw=true) + ![DockerHostsPicture](pictures/DockerPics/DockerContainerHosts.png?raw=true) You should see something like this: -![DockerHostsSearchView](https://github.com/MSFTOSSMgmt/OMS-Agent-for-Linux/blob/master/docs/pictures/DockerPics/DockerContainerInventorySearch.png?raw=true) +![DockerHostsSearchView](pictures/DockerPics/DockerContainerInventorySearch.png?raw=true) From here you can edit the search query to modify it to something specific. For a tutorial on the basics of OMS search, check out the [OMS log search tutorial](https://technet.microsoft.com/library/mt484120.aspx). @@ -65,15 +65,15 @@ From here you can edit the search query to modify it to something specific. For ### Finding a failed container OMS will mark a container as Failed if it has exited with a non-zero exit code. You can see an overview of the errors and failures in the environment in this tile: -![DockerFailedContainerView](https://github.com/MSFTOSSMgmt/OMS-Agent-for-Linux/blob/master/docs/pictures/DockerPics/DockerFailedContainerView.png?raw=true) +![DockerFailedContainerView](pictures/DockerPics/DockerFailedContainerView.png?raw=true) **Try it:** Get specifics of a failed container by clicking on the tile. You’ll see something like this: -![DockerFailedContainerSearchView](https://github.com/MSFTOSSMgmt/OMS-Agent-for-Linux/blob/master/docs/pictures/DockerPics/DockerFailedContainerSearchView.png?raw=true) +![DockerFailedContainerSearchView](pictures/DockerPics/DockerFailedContainerSearchView.png?raw=true) From here, click on one of the image names to get additional information such as image size and number of stopped and failed images. Expand the “show more” to get the image ID: -![DockerContainerExpandedView](https://github.com/MSFTOSSMgmt/OMS-Agent-for-Linux/blob/master/docs/pictures/DockerPics/DockerContainerExpandedView.png?raw=true) +![DockerContainerExpandedView](pictures/DockerPics/DockerContainerExpandedView.png?raw=true) **Try it:** Find the container that is running this image. Type the following into the search box: ``` @@ -81,7 +81,7 @@ Type=ContainerInventory ``` This will show you the logs and you can scroll to see the failed container: -![DockerContainerFailedSearchView](https://github.com/MSFTOSSMgmt/OMS-Agent-for-Linux/blob/master/docs/pictures/DockerPics/DockerContainerFailedSearchView.png?raw=true) +![DockerContainerFailedSearchView](pictures/DockerPics/DockerContainerFailedSearchView.png?raw=true) ### Search Logs When you’re troubleshooting a specific error, it can help to see where it is occurring in your environment. Become familiar with the types of logs so you can construct queries to get the information you want: @@ -97,7 +97,7 @@ When you’re troubleshooting a specific error, it can help to see where it is o Type=ContainerInventory drupal Failed ``` -![DockerDrupalFailedSearchView](https://github.com/MSFTOSSMgmt/OMS-Agent-for-Linux/blob/master/docs/pictures/DockerPics/DockerDrupalFailedSearchView.png?raw=true) +![DockerDrupalFailedSearchView](pictures/DockerPics/DockerDrupalFailedSearchView.png?raw=true) Note the name of the container under “Name”, and do a search for those logs. In our case, it would be `Type=ContainerLog prickly_varahamihira.` @@ -107,31 +107,31 @@ When you’re beginning to construct queries, it can help to see what’s possib Type=Perf * ``` -![DockerPerfSearchView](https://github.com/MSFTOSSMgmt/OMS-Agent-for-Linux/blob/master/docs/pictures/DockerPics/DockerPerfSearchView.png?raw=true) +![DockerPerfSearchView](pictures/DockerPics/DockerPerfSearchView.png?raw=true) You can see this in a more graphical form if you click the word “Metrics” on the upper right: -![DockerPerfMetricsView](https://github.com/MSFTOSSMgmt/OMS-Agent-for-Linux/blob/master/docs/pictures/DockerPics/DockerPerfMetricsView.png?raw=true) +![DockerPerfMetricsView](pictures/DockerPics/DockerPerfMetricsView.png?raw=true) **Try it:** Scope the performance data you’re seeing to a specific container by adding typing the name of it to the right of your query: ``` Type=Perf ``` -![DockerPerfContainerMetricsView](https://github.com/MSFTOSSMgmt/OMS-Agent-for-Linux/blob/master/docs/pictures/DockerPics/DockerPerfMetricsContainerView.png?raw=true) +![DockerPerfContainerMetricsView](pictures/DockerPics/DockerPerfMetricsContainerView.png?raw=true) Scroll around to see the list of which performance metrics are collected for an individual container. ## Example queries Finally, sometimes it can help to build queries by beginning with an example or two and adjusting to fit your environment. Play around with the links on the Notable Queries page (on the far right) to help you build more advanced queries: -![DockerNotableQueries](https://github.com/MSFTOSSMgmt/OMS-Agent-for-Linux/blob/master/docs/pictures/DockerPics/DockerNotableQueries.png?raw=true) +![DockerNotableQueries](pictures/DockerPics/DockerNotableQueries.png?raw=true) ## Saving queries Saving queries is a standard feature in OMS and can help you keep queries you’ve found useful. **Try it:** After you construct a query you find useful, save it by clicking the star at the bottom. This will let you easily access it later from the My Dashboard page. -![DockerDashboardView](https://github.com/MSFTOSSMgmt/OMS-Agent-for-Linux/blob/master/docs/pictures/DockerPics/DockerDashboardView.png?raw=true) +![DockerDashboardView](pictures/DockerPics/DockerDashboardView.png?raw=true) If you’ve made it this far, thanks a bunch. Drop us a line at OMSContainers@microsoft.com and let us know you made it through – tell us what works, what doesn’t, and what we need to build next. diff --git a/docs/OMS-Agent-for-Linux.md b/docs/OMS-Agent-for-Linux.md index a0fc982c2..f5c53670c 100644 --- a/docs/OMS-Agent-for-Linux.md +++ b/docs/OMS-Agent-for-Linux.md @@ -113,20 +113,20 @@ sudo service omsagent restart ### Viewing Syslog events From within the Operations Management Suite portal, access the **Log Search** tile. Predefined syslog search queries can be found in the **Log Management** grouping. -![](https://github.com/MSFTOSSMgmt/OMS-Agent-for-Linux/blob/master/docs/pictures/SyslogLogManagement.png?raw=true) +![](pictures/SyslogLogManagement.png?raw=true) ### Viewing Performance Data From within the Operations Management Suite portal, access the Log Search tile. Enter in the search bar. "* (Type=Perf)" to view all performance counters. -![](https://github.com/MSFTOSSMgmt/OMS-Agent-for-Linux/blob/master/docs/pictures/PerfSearchView.png?raw=true) +![](pictures/PerfSearchView.png?raw=true) ### Viewing Nagios Alerts From within the Operations Management Suite portal, access the Log Search tile. Enter in the search bar, "* (Type=Alert) SourceSystem=Nagios" to view all Nagios Alerts. -![](https://github.com/MSFTOSSMgmt/OMS-Agent-for-Linux/blob/master/docs/pictures/NagiosSearchView.png?raw=true) +![](pictures/NagiosSearchView.png?raw=true) ### Viewing Zabbix Alerts From within the Operations Management Suite portal, access the Log Search tile. Enter in the search bar, "* (Type=Alert) SourceSystem=Zabbix" to view all Zabbix Alerts. -![](https://github.com/MSFTOSSMgmt/OMS-Agent-for-Linux/blob/master/docs/pictures/ZabbixSearchView.png?raw=true) +![](pictures/ZabbixSearchView.png?raw=true) ## Configuring Data Collection Data to collect (e.g. syslog events and performance metrics) can be defined centrally in the Operations Management Suite portal, or on the agents directly. Selections that you define in the portal for data collection will be applied to the agents within 5 minutes. @@ -138,7 +138,7 @@ Data to collect (e.g. syslog events and performance metrics) can be defined cent * Select **Syslogs** from the left-hand settings list * Add or remove *facilities* to collect. For each facility, you can select relevant *severities* to collect -![](https://github.com/MSFTOSSMgmt/OMS-Agent-for-Linux/blob/master/docs/pictures/SyslogConfig.png?raw=true) +![](pictures/SyslogConfig.png?raw=true) ### Configuring Linux Performance Counter collection from the OMS portal * Log into the Operations Management Suite **Portal** @@ -152,7 +152,7 @@ Data to collect (e.g. syslog events and performance metrics) can be defined cent * **(/|/var)** – will match Logical Disk instances named: `/` or `/var` * **_Total** – will match Processor instances named _Total -![](https://github.com/MSFTOSSMgmt/OMS-Agent-for-Linux/blob/master/docs/pictures/PerfConfig.png?raw=true) +![](pictures/PerfConfig.png?raw=true) ## Enabling Application Performance Counters ### Enabling MySQL Performance Counters