Versions Compared

Key

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

...

Step 1. Download Saga Parser

  1. Go to https://repository.searchtechnologiessca.com/artifactory/public/com/accenture/saga/binaries/1.3.34/
  2. Download Saga_Aspire.zip
  3. Extract the Files

...

  1. Copy bundles folder from the extracted files from Saga_Aspire.zip.
  2. Paste the bundles folder to aspire 5 parent directory 
  3. Verify if app-saga-parser and aspire-saga-parser are properly copied to Aspire 5:  {AspireParentDIR}\bundles\aspire


Info
titleUsage of add-ons from Saga-Parser

If you are using the Saga-Parser from Aspire and also using one of the recognizers/processors described in add-on stages, make sure the corresponding .jar file is inside the "lib" folder in Aspire too. You can get these .jar from SagaAspire.zip file, in the "lib" sub-folder.

...

The location of where Saga-Parser should get the JARs from is configurable in the Saga-Parser component UI,  make sure the folder "lib" path is correct.



Step 3. Configure the settings.json of Aspire 5

...

Code Block
themeMidnight
titlebundle
"repositories: {
    ...

	"bundleVersions": {
		"bundle": [
				{
                	"@artifactId": "app-saga-parser",
                	"@groupId": "com.accenture.aspire",
                	"@version": "5.2.02.133000134000"
                },
                {
                	"@artifactId": "aspire-saga-parser",
                	"@groupId": "com.accenture.aspire",
                	"@version": "5.2.02.133000134000"
                }
		]
	}	
}



         

Step 4. Add Saga Config in Aspire 5

  1. Create config.json (The "logging_provider" bit is ONLY FOR 1.3.4^)
    NOTE: The tagManager and pipelineManager keys are also removed in 1.3.4^


    Code Block
    themeMidnight
    titleconfig.json
    {
      "config": {
        "libraryJars": ["./lib"],
        "tagManager": {
          "resource": "saga-provider:saga_tags"
        },
        "pipelineManager": {
          "resource": "saga-provider:saga_pipelines"
        },
        "providers": [
          {
            "name": "filesystem-provider",
            "type": "FileSystem",
            "baseDir": "./config"
          },
          {
            "name": "saga-provider",
            "type": "Elastic",
            "nodeUrls": ["http://localhost:9200"],
            "timestamp": "updatedAt",
            "authentication": "none",
    		"caFilePath": "",
            "trustAllSSL": false,
            "indexName": "saga",
            "exclude": [
              "updatedAt",
              "createdAt"
            ],
            "maxResults": 2000000
          }
        ],
        "logging_provider": {
          "name": "saga-parser-logging-provider",
          "type": "Elastic",
          "nodeUrls": ["http://localhost:9200"],
          "timestamp": "updatedAt",
          "indexName": "saga",
          "authentication": "none",
          "timeout": 90,
          "delay": 5,
          "retries": 3,
          "exclude": [ ]
        }
      }
    }
    Note

    For OpenSearch, replace the "saga-provider" section of type "Elastic" with the corresponding OpenSearch configuration as shown here:

        {
            "name": "saga-provider",
            "type": "OpenSearch",
            "nodeUrls": ["http://localhost:9200"],
            "timestamp": "updatedAt",
            "indexName": "saga",
            "trustAllSSL": false,
            "timeout": 90,
            "delay": 5,
            "retries": 3,
            "include": [],
            "exclude": [],
            "track_total_hits": true,
            "maxResults": 10000
        }


  2. Paste the created config.json file to {AspireParentDIR}\config\saga
  3. Make sure that the info in config.json are correct.
  4. Also, you need to add these two files as well: eventAppenderTemplate.json and sagaLoggerTemplate.json(VERSION 1.3.4)

    Code Block
    themeMidnight
    titleeventAppenderTemplate.json
    {
      "mdc": {
        "$resolver": "mdc"
      },
      "exception": {
        "exception_class": {
          "$resolver": "exception",
          "field": "className"
        },
        "exception_message": {
          "$resolver": "exception",
          "field": "message"
        },
        "stacktrace": {
          "$resolver": "exception",
          "field": "stackTrace",
          "stackTrace": {
            "stringified": true
          }
        }
      },
      "line_number": {
        "$resolver": "source",
        "field": "lineNumber"
      },
      "class": {
        "$resolver": "source",
        "field": "className"
      },
      "@version": 1,
      "source_host": "${hostName}",
      "message": {
        "$resolver": "message",
        "stringified": true
      },
      "thread_name": {
        "$resolver": "thread",
        "field": "name"
      },
      "@timestamp": {
        "$resolver": "timestamp"
      },
      "level": {
        "$resolver": "level",
        "field": "name"
      },
      "file": {
        "$resolver": "source",
        "field": "fileName"
      },
      "method": {
        "$resolver": "source",
        "field": "methodName"
      },
      "logger_name": {
        "$resolver": "logger",
        "field": "name"
      }
    }
    Code Block
    themeMidnight
    titlesagaLoggerTemplate.json
    {
      "index_patterns": [
        "*_logger*"
      ],
      "priority": 300,
      "template": {
        "settings": {
          "index": {
            "refresh_interval": "5s"
          }
        },
        "mappings": {
          "properties": {
            "class": {
              "type": "text",
              "index": false
            },
            "message": {
              "type": "text",
              "index": false
            },
            "date_time": {
              "type": "date",
              "format": "date_time"
            },
            "level": {
              "type": "text",
              "index": false
            }
          }
        }
      }
    }


Step 5. Run Aspire 5

Step 6. Add Saga Parser in the Extension Manager

...

      Engine Pool Size: Number of SAGA engines.

      Create Engines Beforehand: Create the Engines BEFORE crawling instead at the time of actual cralwscrawls.

      Tags/Processors: Select if you want to use SAGA tags or a specific Processor (pipeline stage).

...