Presentation is loading. Please wait.

Presentation is loading. Please wait.

Netuitive Studio 2.x User Training. Netuitive, Inc. All rights reserved. Company confidential Module 1 – Overview In this module, you: Learn about the.

Similar presentations


Presentation on theme: "Netuitive Studio 2.x User Training. Netuitive, Inc. All rights reserved. Company confidential Module 1 – Overview In this module, you: Learn about the."— Presentation transcript:

1 Netuitive Studio 2.x User Training

2 Netuitive, Inc. All rights reserved. Company confidential Module 1 – Overview In this module, you: Learn about the function and use of Netuitive Studio. Learn about the software requirements for Studio. Learn how to install the Studio plugin in Eclipse. Learn how to update the Studio plugin Learn how to uninstall the Studio plugin 2

3 Netuitive, Inc. All rights reserved. Company confidential Studio Use Case Intended for developers responsible to build new integrations, templates or extending templates An Eclipse-based plugin that provides an IDE for architects & programmers to create custom software applications Core value proposition Creating an extensible platform Access data from any data source Applying the power of the Netuitive engine Customizing analytics and models Providing solutions other than just vendor-only solutions 3

4 Netuitive, Inc. All rights reserved. Company confidential Studio Requirements Netutiive Software Netuitive 6.0 and above Studio Eclipse-plugin Does not need to be on the same physical machine as the one running Studio Remote Collector software is optional (needed only if using RC as a data source) Third-party software JDK 6 (JDK 7 not currently supported)  http://www.oracle.com/technetwork/java/javasebusiness/downloads/javaarchiv e-downloads-javase6-419409.html#jre-6u33-oth-JPR Eclipse 3.7.2  http://www.eclipse.org/downloads/packages/eclipse-classic-372/indigosr2/ 4

5 Netuitive, Inc. All rights reserved. Company confidential Supported Data Sources Data SourceVersions Remote Collector3.x, 2.x * Microsoft SQL Server2012, 2008, 2005 Oracle Database11g, 10g MySQL Server5.1.69 5 *The Remote Collector instance does not need to be on the same physical machine as Eclipse. Remote Collector 3.x may use a HTTP or HTTPS connection. Remote Collector 2.x must use a JMX Over RMI connection.

6 Netuitive, Inc. All rights reserved. Company confidential Installing Eclipse Eclipse 3.7.2 MUST be installed before you can install Studio plugin How to Install Eclipse Download & install JDK 6 Download Eclipse 3.7.2 Unzip downloaded file & move entire package to desired installation directory Launch Eclipse & choose workspace (avoid use of spaces & special chars except underscore in workspace name) 6

7 Netuitive, Inc. All rights reserved. Company confidential Installing Studio Plugin Launch Eclipse Click Help, and then Install New Software In the Install window, click Add In the Add Repository window, for Name, type Netuitive. for Location, type the URL shown below, and then click OK: http://tools.netuitive.com/studio Select the Netuitive UI, then click Next. Review the installation details, and then click Next. Review the licenses, select I accept the terms of the license agreements, and then click Finish. If a Security Warning window appears, click OK. If a Software Updates window appears, click Restart Now to apply the changes. 7

8 Netuitive, Inc. All rights reserved. Company confidential Installing Studio Plugin in Eclipse 8

9 Netuitive, Inc. All rights reserved. Company confidential Updating the Studio Plugin Not supported for beta versions of Studio 9

10 Netuitive, Inc. All rights reserved. Company confidential Updating the Studio Plugin 10

11 Netuitive, Inc. All rights reserved. Company confidential Updating the Studio Plugin 11

12 Netuitive, Inc. All rights reserved. Company confidential Updating Studio Plugin 12

13 Netuitive, Inc. All rights reserved. Company confidential Uninstalling the Studio Plugin 13

14 Netuitive, Inc. All rights reserved. Company confidential Uninstalling the Studio Plugin 14

15 Netuitive, Inc. All rights reserved. Company confidential Uninstalling the Studio Plugin 15

16 Netuitive, Inc. All rights reserved. Company confidential Uninstalling Studio Plugin 16

17 Netuitive, Inc. All rights reserved. Company confidential Module 2 – Working With Studio In this module, you: Learn about opening and using the Studio Perspective Learn how to connect to a Remote Collector Data Source Learn how to connect to a JDBC Data Learn how to used Netuitive Reference Search 17

18 Netuitive, Inc. All rights reserved. Company confidential Opening Netuitive Studio Perspective 18

19 Netuitive, Inc. All rights reserved. Company confidential Netuitive Studio Perspective Netuitive Perspective consists of the following views Project Explorer Key Matcher Design or Source Editor (covered in detail later) Netuitive Servers (covered in detail later) Studio Data Source Explorer (covered in detail later) 19

20 Netuitive, Inc. All rights reserved. Company confidential Opening Netuitive Studio Perspective 20

21 Netuitive, Inc. All rights reserved. Company confidential Netuitive Perspective – Project Explorer 21 Provides a hierarchical view of the resources in Studio Open files for editing or select wizards for operations such as creating mapping, modeling, or resource files. Right-clicking on any resource to open pop-up menu to perform operations such as Copying Moving Creating new resources Comparing resources with each other Building projects Performing team operations

22 Netuitive, Inc. All rights reserved. Company confidential Netuitive Perspective – Key Matcher Connects to Netuitive data sources and databases Remote Collector data sources Database connections Display a list of unmapped keys in a Tree and List View Assist in the creation of regular expressions by Allowing you to specify the regex and  Showing matched keys (equality symbol)  Showing unmatched keys (inequality symbol)  Showing all keys (universal quantification symbol) 22

23 Netuitive, Inc. All rights reserved. Company confidential Netuitive Perspective Key Matcher View 23

24 Netuitive, Inc. All rights reserved. Company confidential Connecting to a Remote Collector Data Source 24 If using Remote Collector adapter as a data source, you will need to setup a connection between Studio and the Remote Collector You may create connections to multiple Remote Collectors After creating the Remote Collector data source, you will need to connect to it for use with the Key Matcher

25 Netuitive, Inc. All rights reserved. Company confidential Connecting to a Remote Collector Data Source 25

26 Netuitive, Inc. All rights reserved. Company confidential Connecting to a Remote Collector Data Source 26

27 Netuitive, Inc. All rights reserved. Company confidential Modifying Remote Collector data source properties Properties are edited using the Properties for window. 3 Tabs Common Connection Properties Version You may need to restart Eclipse if you rename a Remote Collector data source and the updated name does not appear in the Key Matcher (known issue) 27

28 Netuitive, Inc. All rights reserved. Company confidential JDBC Database data sources If using a JDBC database as a data source, you will need to setup a connection between Studio and a MS SQL, MySQL Server or Oracle DB. May create connections to multiple databases, each of which will appear under the Database Connections folder Create connection by first selecting a Connection Profile 28

29 Netuitive, Inc. All rights reserved. Company confidential Configuring a connection to an MS SQL data source 29 Settings Database Host Port number User name Password Save password Connection URL

30 Netuitive, Inc. All rights reserved. Company confidential Configuring a connection to MySQL data source 30 Settings Database URL User name Password Save password

31 Netuitive, Inc. All rights reserved. Company confidential Configuring a connection to Oracle data source 31 Settings SID Host Port number User name Password Save password Connection URL Catalog

32 Netuitive, Inc. All rights reserved. Company confidential Using Netuitive Reference Search Designed to allow you to search standard Netuitive assets and Reference Templates for all projects selected when you launch Search. Keyboard shortcut Ctrl+H or Search menu from top menu bar 32

33 Netuitive, Inc. All rights reserved. Company confidential Using Netuitive Reference Search Containing Text Use this field to type a search query Case Sensitive & Regular Expression options Node Select one option to limit search criteria If All is chosen, then search results display color coded symbols under Type Current Search Projects Current or selected projects are shown in this field. To search multiple projects, select them from Project Explorer before opening this view Include Netuitive References Select this to include standard Netuitive assets in search 33

34 Netuitive, Inc. All rights reserved. Company confidential Using Netuitive Reference Search Results 34

35 Netuitive, Inc. All rights reserved. Company confidential Using Netuitive Reference Search 35

36 Netuitive, Inc. All rights reserved. Company confidential Module 3 – Creating Projects In this module, you: Learn about overview of studio projects Learn about namespace guidelines Learn how to create a new project Learn how to share studio projects Learn how to import studio projects 36

37 Netuitive, Inc. All rights reserved. Company confidential Studio Projects Overview In Studio, the top level organization for the Reference, Model and Mapping Templates is called a project Each project is built as a standard Netuitive package Important to choose a project name carefully because it becomes part of the overall namespace, and the namespace is used to name the integration in Netuitive. Try to use project names such as com.vendor.product.organization or org.product to keep the namespace organized and self-explanatory 37

38 Netuitive, Inc. All rights reserved. Company confidential Studio Project Structure top level folder – named after namespace adapters – used to store adapters (not needed if using RC as data source) build – contains output of build process mapping – store Mapping Templates models – store Model Templates reference – store Reference Templates build.properties – auto generated properties file. build.xml – Use to run the build process In addition to basic structure above, you may see child folders related to the namespace in the adapters, mapping, models & reference folders 38

39 Netuitive, Inc. All rights reserved. Company confidential Studio Project Namespace guidelines Following the guidelines will make namespaces consistent & predictable throughout a Studio project 3 possible namespace scenarios: Generic integration namespace – A namespace for a specific application without using an organization name Integration specific to a company – A namespace for an integration with a specific product at a specific company Hierarchy of applications specific to a company – A namespace for an integration with a product that has a hierarchy of custom applications for a specific company We will use some examples to illustrate the guidelines 39

40 Netuitive, Inc. All rights reserved. Company confidential Integration Namespace Defined when the project is created Determines the structure of the folders in the Project Explorer Namespace is defined automatically in the integration ID in integration.xml file The integration namespace is always the first part of the mapping, model, reference and metric namespaces Recommended form.. [. ][. ][. ] By default, Studio uses the last word of the integration namespace to name the integration 40

41 Netuitive, Inc. All rights reserved. Company confidential Mapping Namespace Composed of the integration namespace and the mapping name segment Mapping name segment is determined by the file name chosen when creating the Mapping Template Netuitive recommends naming the template files after the model for which they are associated Recommended forms............ 41

42 Netuitive, Inc. All rights reserved. Company confidential Model Namespace The model namespace is composed of the integration namespace and the model name segment The model name segment is determined by the file name chosen when creating the Model Template The model namespace is defined automatically in the model ID in the Model Template file Recommended forms............ 42

43 Netuitive, Inc. All rights reserved. Company confidential Reference Namespace The model namespace is composed of the integration namespace and the reference name segment The reference name segment is determined by the file name chosen when creating the Reference Template The reference namespace is defined automatically in the reference ID in the Reference Template file Recommended forms............ Every entity that is scanned must be assigned an ID in the Reference template The fully qualified ID for an entity consists of the reference namespace and a unique entity ID in the format. With the exception of the primary workload metric id, the fully qualified ID is not used in the Reference Template but used in the Model & Mapping Templates 43

44 Netuitive, Inc. All rights reserved. Company confidential Metric Namespace The metric namespace is a fully qualified ID Composed of the reference namespace and the metric segment The metric segment is defined by the metric ID in the Reference Template Example: org.sflow.application.SuccessCount Recommended forms............... The Mapping and Model templates use the metric namespace in multiple places. 44

45 Netuitive, Inc. All rights reserved. Company confidential Creating a new Project New projects can be created using the File menu or by right clicking in the Project Explorer Each new project contains 2 files that should not be modified, moved or deleted – build.properties and build.xml The integration.xml file should not be moved or deleted, but may be edited The integration’s name is used to define and identify a data source in Netuitive. A custom integration name is necessary when using a naming convention that results in multiple project’s namespaces ending with the same word as Netuitive uses the last word as the value for the integration name. Name in integration.xml file may be Any combo of lowercase and uppercase letters Numbers, but as the first character A space or underscore after the first character and before another character 45

46 Netuitive, Inc. All rights reserved. Company confidential Creating a Project 46

47 Netuitive, Inc. All rights reserved. Company confidential Sharing Studio Projects Easiest way to share Studio projects is to package the project from your workspace as an archive (compressed/zipped) file After the project is archived, you can send the project to another user or transport the file to a different computer Once the file is received, you will extract the file before importing it into Eclipse When archiving the project, remember to zip the file at the project folder level If you save the project folder (after unzipping) to a location such as the Desktop you can use Studio to copy the files to your workspace during import 47

48 Netuitive, Inc. All rights reserved. Company confidential Importing Projects Projects can be imported from other instances of Studio Project folder must be un-archived (uncompressed) and in a location accessible from local machine From the Project Explorer, right click on Import Check the “Copy projects into workspace” if you want Eclipse to copy the project files into your workspace. 48

49 Netuitive, Inc. All rights reserved. Company confidential Module 4 – Developing Adapters In this module, you: Learn about creating a database adapter Learn about using the Database Adapter View Learn how to write a query 49

50 Netuitive, Inc. All rights reserved. Company confidential Developing Adapters Overview An adapter is the part of a Netuitive integration used to collect data from third party products The adapter is the channel for the transport of data Different integrations require different adapters Currently the only type of adapter that can be built and deployed using Studio is a JDBC Database adapter The Remote Collector is the preferred method to collect data if the JDBC Database adapter is not applicable Currently building Remote Collector plug-ins is only performed by Professional Services 50

51 Netuitive, Inc. All rights reserved. Company confidential Building a JDBC adapter - Steps Create the adapter file In Project Explorer, right click, then select New Database Adapter Ensure correct integration name is selected or click New to create a new project Choose a unique name for adapter file. Do not use special characters For description, type a description that gives details about the database and tables to which the adapter is connecting For database, select the type of database to connect Click Finish Write the necessary SQL queries using the Database Adapter editor view Confirm that the adapter provides the correct info, including keys, for the integration. If necessary adjust the SQL queries 51

52 Netuitive, Inc. All rights reserved. Company confidential Creating the JDBC database adapter file 52

53 Netuitive, Inc. All rights reserved. Company confidential JDBC database adapter queries Keys Query Also called the scan query, is used to bring in the element names, metric names, instance names and attributes. Result of this query will appear in the Key Matcher view No required parameters Result of query should be a single column of string with each metric appearing in its own row Collection Query Also called the collect query, runs every cycle and is used to collect data When executed, it will be provided the start and end time parameters in GMT Should include one or more pairs of “?” parameter tokens Result should be two columns, the first is the same as the Key Query (string), the second is numeric representing the mean value of the metric for the specified time period 53

54 Netuitive, Inc. All rights reserved. Company confidential JDBC database adapter queries Relationship Query Optional query used to define relationships between managed elements. Executed without parameters. A pair of managed element names and managed element types denoting parent and child are the required meta data Result is a single column of string containing the pair of elements 54

55 Netuitive, Inc. All rights reserved. Company confidential Using the Database Adapter view Provides an abstraction layer to create, edit and test the database adapter. 3 main sections to select queries and databases, connection profile and write SQL queries 55

56 Netuitive, Inc. All rights reserved. Company confidential Use to add additional databases Use to add new SQL queries Use to test the query against the selected database Valid SQL queries will have syntax highlighting. Syntax highlighting will disappear if an invalid query is written Before testing a query, open the SQL Results view (main menu Window  Show View  SQL Results) 56 Using the Database Adapter view

57 Netuitive, Inc. All rights reserved. Company confidential Module 5 – Developing Templates In this module, you: Learn about Netuitive Templates Learn how to create a template Learn about Reference Templates Learn about Model Templates Learn about Mapping Templates 57

58 Netuitive, Inc. All rights reserved. Company confidential Netuitive Templates Overview Templates allow Netuitive to map, model and analyze data Netuitive templates come in 3 forms: Reference – use this template to define element types, metrics & attributes Model – use this template to define element structures, metric expressions, alarming, baseline & correlation Mapping – use this template to map keys and metrics to models Netuitive recommends naming template files after the model for which they are associated One template of each type per model When choosing a filename for a new template keep in mind Name the template using a short descriptive name that corresponds with the model Template names must be unique within the category of templates. Do not use special characters Do not use file extensions in the template’s name 58

59 Netuitive, Inc. All rights reserved. Company confidential Template Validation Studio performs XML schema validation on templates to identify errors Validation on template expressions and IDs Possible error categories [01 SCHEMA] [02 REFERENCE] [03 MAPPING] [04 MODEL] A red x will displayed over project folder in the Project Explorer as well as offending file Errors can also be reported in the Problems view or in the Console view during project building 59

60 Netuitive, Inc. All rights reserved. Company confidential Creating Templates In the Project Explorer view, right click and then select New Reference or Model or Mapping Template Fill in the form for the corresponding template typing in a short optional note and description Click Finish A blank template is created in the appropriate folder 60

61 Netuitive, Inc. All rights reserved. Company confidential Creating a Template 61

62 Netuitive, Inc. All rights reserved. Company confidential Reference Templates Define normalized concepts such as elements, attributes, metrics. Essentially a list of concepts, to which are used to link mapping and modeling templates together The Reference Template is also used for adding custom normalized definitions in Netuitive for Resources Functions Element Types Attributes Metrics Reference Templates do not contain computed metrics (they are defined in Model Templates) Properties associated with metrics are considered intrinsic and cannot be changed or overridden 62

63 Netuitive, Inc. All rights reserved. Company confidential Reference Templates - Resources A resource represents a type of computing resource (e.g. CPU or MEM) to which this metric belongs a found on the Metric Details page in Netuitive Console Example: CPU Processor deals with the utilization of the processor resources available 63

64 Netuitive, Inc. All rights reserved. Company confidential Reference Templates - Functions Functions define the purpose (or use) of the Managed Element (e.g. Database for a DB server or Mail for a messaging server) Managed Elements can have multiple functions but only one can be the primary function Example APPSVR Application server 64

65 Netuitive, Inc. All rights reserved. Company confidential Reference Templates – Element Types Defines a distinct element type, which dictates how the Managed Element is licensed, represented, and processed by Netuitive. Element names must be unique within a type Can be dependent (has a parent) or independent Example: <element id="com.netuitive.common.elements.Server” dependent=“false"> Server 65

66 Netuitive, Inc. All rights reserved. Company confidential Reference Templates – Attributes Attributes represent infrequently changing properties of an element (e.g. the OS version, number of CPUs) Example: <attribute id="com.netuitive.virtual_machine.BootTime” datatype=“java.lang.Number"> Boot Time Time when Managed Element was last booted up. <attribute id="com.netuitive.virtual_machine.FaultToleranceState” datatype="java.lang.String"> Fault Tolerance State 66

67 Netuitive, Inc. All rights reserved. Company confidential Reference Templates – Metrics Define the time series data concept being processed by the Analytics Service Example: <metric id="com.netuitive.os.ActiveProcesses” resource="com.netuitive.common.resources.PROC” minValidValue="0.0" units="unknown"> Active Processes Number of processes running on a system. Since the amount of resources any given process consumes is quite variable, this measurement is hard to judge with hard limits. When the number of processes becomes unusually high for the typical load then other performance measurements are likely to spike. 67

68 Netuitive, Inc. All rights reserved. Company confidential Model Template Defines the default behavior for processing metric values within the Managed Element model, what computed metrics to derive, and what model to create based on the metrics discovered Model Templates possess a flexible mechanism for defining applicability rules for Managed Elements Properties Expressions defaultModelDriverClass : Required. Use default traitId : Optional. If not defined, defaults to Model Template ID rootTraitId: Optional. If not defined, defaults to traitId functionId: Optional. If not defined, defaults to “none” 68

69 Netuitive, Inc. All rights reserved. Company confidential Model Template - Applies-to Expressions Rules for specifying which elements to apply the template definition 3 conditions - applies to the specified element type - applies if model has specified collected metric - applies if model has a specified attribute Conditions can be nested with or operators Example 69

70 Netuitive, Inc. All rights reserved. Company confidential Model Template – Model Inputs Specifies what metrics make up the model and their corresponding analytics processing settings Settings include initialHistoricalMax : initial max value observed impliesModel : existence of this metric implies model enabled : metric is included or not in the model alarming : if true, metric is AGI thresholds : upper/lower filter settings baseline : compute baseline for this metric? correlation : include metric in correlation matrix? trending : compute long-term trends for metric expressions : define computed expression for deriving metric values. Order of precedence is as listed 70

71 Netuitive, Inc. All rights reserved. Company confidential Mapping Template Specifies how keys are mapped to create elements, instances and metrics A mapping consists of A regex pattern for matching the key produced by the adapter One or more element mappings that define the element hierarchy A one-to-one mapping for each metric and attribute 71

72 Netuitive, Inc. All rights reserved. Company confidential Mapping Template – mapping a single metric $2 Bytes Received/sec Network Bytes In Per Second Bytes Sent/sec Network Bytes Out Per Second 72 If match then com.netuitive.os.NetworkBytesInPerSecond

73 Netuitive, Inc. All rights reserved. Company confidential Mapping Template – mapping an attribute $3 cpu_num cpu_speed 73 If match then org.sflow.host.NumCPU If match then org.sflow.host.CPUSpeed

74 Netuitive, Inc. All rights reserved. Company confidential Module 6 – Building & Deploying Projects In this module, you: Learn about building a project Learn how to connect to a Netuitive Server Learn how to deploy a project Learn how to configure a data source in Netuitive 74

75 Netuitive, Inc. All rights reserved. Company confidential Overview Projects are built from inside the Project Explorer using the generated build scripts The build process runs the builder inside Eclipse and produces a Netuitive drop-in package The build script should not be modified. They are recreated if moved or deleted. The output of the build process is printed to the Eclipse Console view A project may be built even if the project has errors, however the resulting drop-in may not function correctly 75

76 Netuitive, Inc. All rights reserved. Company confidential Building a Project Projects are built using the Netuitive Studio  Build Netuitive Drop-in build option, accessible by right-clicking the build.xml file The build is packaged as a zip file located in the build folder 76

77 Netuitive, Inc. All rights reserved. Company confidential Building a Project 77

78 Netuitive, Inc. All rights reserved. Company confidential Connecting to a Netuitive Server You can deploy a project to a Netuitive server directly from Studio. Before deploying you must first connect to the server using the Netuitive Servers view 78

79 Netuitive, Inc. All rights reserved. Company confidential Connecting to a Netuitive Server 79

80 Netuitive, Inc. All rights reserved. Company confidential Deploying a Project Projects may be deployed to a Netuitive server using the Project Explorer view Before deploying you must Verify that the connection established with the server is valid Build the project After deploying you must Restart the Netuitive Analytics Service, the Netuitive Proxy Collector & Netuitive Tomcat Service Configure a data source in Netuitive 80

81 Netuitive, Inc. All rights reserved. Company confidential Deploying a Project In Project Explorer, select the project, right click and select Deploy Studio Project Select the Netuitive Server Select the “Deploy” and “Run DB Update” checkboxes Click “OK” 81

82 Netuitive, Inc. All rights reserved. Company confidential Deploying a Project 82


Download ppt "Netuitive Studio 2.x User Training. Netuitive, Inc. All rights reserved. Company confidential Module 1 – Overview In this module, you: Learn about the."

Similar presentations


Ads by Google