Versions Compared

Version Old Version 5 New Version 6
Changes made by

Akshay Sharma (Unlicensed)

Surbhi Gupta

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Anchor
top1
top1


Tip

In order to setup an Agent, it's configuration, please check the information related to the Agent in the table provided below.


Panel


S.NoProperty TypeProperty NameTool NameDescription
1GenerictoolsTimeZoneAll ToolsTime zone in which the DevOps tool(i.e. Jenkins, JIRA, GIT) is running
2GenericstartFromAll ToolsDate and Time using which the data collection of the Agent will start
3GenericisDebugAllowedAll ToolsFlag to set debugging to true or false. Useful for seeing more logs
4GenericuseResponseTemplateAll ToolsFlag to turn on the usage of Response Template
5GenericrunScheduleAll ToolsScheduler frequency of Agent in mins. Recommended - 30
6GenerictimeFieldMappingAll ToolsAdd the timeStampField here to get equivalent epoch time generated
Eg: for Git
timeFieldMapping: { commitTime : "%Y-%m-%dT%H:%M:%S.%fZ"}
7GenericResponseTemplateAll ToolsDefines the field to be collected from the Rest API calls
Eg data for Git. In the below example, fields highlighted in Blue is from the API response from the DEvOps tools and text highlighted in green are the attributes that will be stored in Neo4j. Attributes/field names in Neo4j follows camelCase Naming Convention
"responseTemplate" : {
   "sha": "commitId",
   "commit" : {
                "author" : {
                          "name": "authorName",
                          "date": "commitTime"
                          }
                    }
          }
8Tool SpecificIsEnrichmentRequiredSCMBoolean value, which takes the input whether the user wants to go for Data Enrichment(which is mandatory for creating a correlation)
9Tool SpecificSourcePropertySCMProperty of the SCM tool whose value will be picked up the engine , for processing data enrichment.
10Tool SpecificKeyPatternSCMA pattern to be entered , based on which the value from Source property will be fetched and stored.
11Tool SpecificTargetPropertySCMProperty of the SCM tool, which will store the calculated value of data Enrichment.It is used for creating correlations.
12Tool SpecificuseridHP ALMValid UserID with access to read tool data
913Tool SpecificpasswdHP ALMPassword of the mentioned UserID
1014Tool SpecificbaseEndPointHP ALMUrl of the HP ALM(ex http://hostname:8080)
1115Tool SpecifictimeStampFieldHP ALMlast-modified
1216Tool SpecifictimeStampFormatHP ALMTime stamp format of the field specified in timeStampField
1317Tool SpecificdataFetchCountHP ALMIt is count of the event to be fetched for one REST call
1418Tool SpecificuseResponseTemplateHP ALM true
1519Tool SpecificuseridJiraValid UserID with access to read tool data
1620Tool SpecificpasswdJiraPassword of the mentioned UserID
1721Tool SpecificbaseUrlJira#Jira_URL#/rest/api/2/search
1822Tool SpecificuseResponseTemplateJira true
1923Tool SpecifictimeStampFieldJiralastUpdated
2024Tool SpecifictimeStampFormatJiraTime stamp format of the field specified in timeStampField
2125Tool SpecificuseridArtifactoryValid UserID with access to read tool data
2226Tool SpecificpasswdArtifactoryPassword of the mentioned UserID
2327Tool SpecificBaseUrlArtifactoryREST URL to get list of Artifactory repositories(ex. https://<HOSTNAME>:8081/artifactory/api)
2428Tool SpecificFirstEndPointArtifactoryREST URL to get list of  repositorie details (http://<HOSTNAME>:8081/artifactory/api/storage/)
2529Tool SpecificuseResponseTemplateArtifactory true
2630Tool SpecifictimeStampFieldArtifactorylastUpdated
2731Tool SpecifictimeStampFormatArtifactoryTime stamp format of the field specified in timeStampField
2832Tool SpecificuseridJenkinsValid UserID with access to read tool data
2933Tool SpecificpasswdJenkinsPassword of the mentioned UserID
3034Tool SpecificuseResponseTemplateJenkins true
3135Tool SpecificuseAllBuildsApiJenkinsIf it is set false it will take only latest 100 elements, if is set true retrive all builds
3236Tool SpecificbaseUrlJenkins#Jenkins_URL#
3337Tool SpecificjenkinsMastersJenkins#Jenkins_Master_URL#
3438Tool SpecifictimeStampFieldJenkinsbuildTimestamp
3539Tool SpecifictimeStampFormatJenkinsTime stamp format of the field specified in timeStampField
3640Tool Specificaccess_key_idAWSIi is the access key of an IAM user which has access all services in AWS(i.e PowerUser)
3741Tool Specificsecret_access_keyAWSIt is the Secret key of the specified access key
3842Tool SpecifictimeStampFieldAWSlaunchTime
3943Tool SpecifictimeStampFormatAWSTime stamp format of the field specified in timeStampField
4044Tool Specificvpc_idAWSSpecify the VPC ID(s)
4145Tool SpecificuseResponseTemplateAWS false
4246Tool SpecificAdditional LibrarySVNAgent setup includes download of boto3 library
4347Tool SpecificusernameServiceNowValid UserName with access to read tool data which should have access to folllowing table change_request, sysapproval_approver, incident, sysapproval_group
4448Tool SpecificpasswordServiceNowPassword of the mentioned Username
4549Tool SpecificbaseUrlServiceNow#Service-Now_URL#
4650Tool SpecifictimeStampFieldServiceNowSpecify the unique field in SNOW data(ex. commitTime) to refer time for each event
4751Tool SpecifictimeStampFormatServiceNowTime stamp format of the field specified in timeStampField
4852Tool SpecificusernameSVNValid UserName with access to read tool data of all repositories
4953Tool SpecificpasswordSVNPassword of the mentioned Username
5054Tool SpecificbaseUrlSVNSpecify the URL of the repositories you need to monitor in list(ex. baseUrl : ["http://<HOSTNAME>:18080/svn/repo1","http://<HOSTNAME>:18080/svn/repo2"] )
5155Tool SpecifictimeStampFieldSVNSpecify the unique field in SVN data(ex. commitTime) to refer time for each event
5256Tool SpecifictimeStampFormatSVNTime stamp format of the field specified in timeStampField
5357Tool SpecificResponseTemplateSVN false
5458Tool SpecificAdditional LibrarySVNAgent setup includes download of pysvn library
5559Tool SpecificaccessTokenGITValid UserName access token to read GIT data of all repositories
5660Tool SpecificgetReposGIT#GitHub_URL#/user/repos
5761Tool SpecificcommitsBaseEndPointGIT#GitHub_URL#/repos/repo_name
5862Tool SpecifictimeStampFieldGITcommitTime
5963Tool SpecifictimeStampFormatGITTime stamp format of the field specified in timeStampField
6064Tool SpecificuseridSONARValid UserID with access to read tool data
6165Tool SpecificpasswdSONARPassword of the mentioned UserID
6266Tool SpecificuseResponseTemplateSONAR false
6367Tool SpecifictimeMachineapiSONARyes/no - this is based on the Sonar version
6468Tool SpecificbaseUrlSONAR#Sonar_URL#
6569Tool SpecifictimeStampFieldSONARbuildTimestamp
6670Tool SpecifictimeStampFormatSONARTime stamp format of the field specified in timeStampField



Top Section