Atlassian uses cookies to improve your browsing experience, perform analytics and research, and conduct advertising. Accept all cookies to indicate that you agree to our use of cookies on your device.
Atlassian cookies and tracking notice, (opens new window)
Atlassian uses cookies to improve your browsing experience, perform analytics and research, and conduct advertising. Accept all cookies to indicate that you agree to our use of cookies on your device. Atlassian cookies and tracking notice, (opens new window)
Confluence

Aspire 5
Results will update as you type.
  • What is Aspire?
  • Getting Started
  • Generative AI
  • Crawling Features
  • Rest API Usage
    • Configuration and control API
    • Debug API (Aspire 5.3)
    • Manager Node API
    • Metrics API
    • Push Updates API (Aspire 5.3)
    • Resources API
    • Security API
    • Worker Node API
  • Configuration
  • How-to articles
  • Connectors
  • Publishers
  • Workflows
  • Aspire Tools
    Calendars

You‘re viewing this with anonymous access, so some content might be blocked.
/
Debug API (Aspire 5.3)
Updated Mar 30

    Debug API (Aspire 5.3)

       

      The debug API provides various debug information

      • 1 Stack traces for running workers
      • 2 Application components status
      • 3 Download logs

      Stack traces for running workers

      Get stack traces for running workers. This endpoint needs the ADMINISTRATOR  role to be executed.

      GET /aspire/_api/debug/stackTracesForWorkers

      Response

      {
          "manager": {
              "name": "C11-F2GIER94G97:50507",
              "worker": [
                  {
                      "name": "C11-F2GIER94G97:50508",
                      "thread": [
                          {
                              "stackTrace": [
                                  "java.base@17.0.4.1/jdk.internal.misc.Unsafe.park(Native Method)",
                                  "java.base@17.0.4.1/java.util.concurrent.locks.LockSupport.park(LockSupport.java:341)",
                                  "java.base@17.0.4.1/java.util.concurrent.locks.AbstractQueuedSynchronizer$ConditionNode.block(AbstractQueuedSynchronizer.java:506)",
                                  "java.base@17.0.4.1/java.util.concurrent.ForkJoinPool.unmanagedBlock(ForkJoinPool.java:3463)",
                                  "java.base@17.0.4.1/java.util.concurrent.ForkJoinPool.managedBlock(ForkJoinPool.java:3434)",
                                  "java.base@17.0.4.1/java.util.concurrent.locks.AbstractQueuedSynchronizer$ConditionObject.await(AbstractQueuedSynchronizer.java:1623)",
                                  "java.base@17.0.4.1/java.util.concurrent.LinkedBlockingQueue.take(LinkedBlockingQueue.java:435)",
                                  "java.base@17.0.4.1/java.util.concurrent.ThreadPoolExecutor.getTask(ThreadPoolExecutor.java:1062)",
                                  "java.base@17.0.4.1/java.util.concurrent.ThreadPoolExecutor.runWorker(ThreadPoolExecutor.java:1122)",
                                  "java.base@17.0.4.1/java.util.concurrent.ThreadPoolExecutor$Worker.run(ThreadPoolExecutor.java:635)",
                                  "java.base@17.0.4.1/java.lang.Thread.run(Thread.java:833)"
                              ],
                              "threadId": 52,
                              "threadName": "EventAdminAsyncThread #6",
                              "threadState": "WAITING"
                          },
                          {
                              "stackTrace": [
                                  "java.base@17.0.4.1/java.lang.Object.wait(Native Method)",
                                  "java.base@17.0.4.1/java.lang.Object.wait(Object.java:338)",
                                  "org.apache.felix.scr.impl.ComponentActorThread.run(ComponentActorThread.java:83)",
                                  "java.base@17.0.4.1/java.lang.Thread.run(Thread.java:833)"
                              ],
                              "threadId": 58,
                              "threadName": "SCR Component Actor",
                              "threadState": "WAITING"
                          },
                          {
                              "stackTrace": [
                                  "java.base@17.0.4.1/jdk.internal.misc.Unsafe.park(Native Method)",
                                  "java.base@17.0.4.1/java.util.concurrent.locks.LockSupport.park(LockSupport.java:341)",
                                  "java.base@17.0.4.1/java.util.concurrent.locks.AbstractQueuedSynchronizer$ConditionNode.block(AbstractQueuedSynchronizer.java:506)",
                                  "java.base@17.0.4.1/java.util.concurrent.ForkJoinPool.unmanagedBlock(ForkJoinPool.java:3463)",
                                  "java.base@17.0.4.1/java.util.concurrent.ForkJoinPool.managedBlock(ForkJoinPool.java:3434)",
                                  "java.base@17.0.4.1/java.util.concurrent.locks.AbstractQueuedSynchronizer$ConditionObject.await(AbstractQueuedSynchronizer.java:1623)",
                                  "java.base@17.0.4.1/java.util.concurrent.LinkedBlockingQueue.take(LinkedBlockingQueue.java:435)",
                                  "java.base@17.0.4.1/java.util.concurrent.ThreadPoolExecutor.getTask(ThreadPoolExecutor.java:1062)",
                                  "java.base@17.0.4.1/java.util.concurrent.ThreadPoolExecutor.runWorker(ThreadPoolExecutor.java:1122)",
                                  "java.base@17.0.4.1/java.util.concurrent.ThreadPoolExecutor$Worker.run(ThreadPoolExecutor.java:635)",
                                  "java.base@17.0.4.1/java.lang.Thread.run(Thread.java:833)"
                              ],
                              "threadId": 53,
                              "threadName": "EventAdminAsyncThread #7",
                              "threadState": "WAITING"
                          },
      ...................

      Status: 200

       


       

      Application components status

      Gets status information for components of a given application (aka Debug console information). This endpoint needs the ADMINISTRATOR  role to be executed.

      GET /aspire/_api/debug/applicationStatus/:applicationName

      Path and Request Body Parameters

      Name

      Type

      Required

      Description

      applicationName

      string

      Required

      The application name - e.g. a11a244b-ad4d-48fc-a952-08f85d7777d2-fs

      Response

      {
        "manager": {
          "name": "C11-F2GIER94G97:50507",
          "worker": [
            {
              "name": "C11-F2GIER94G97:50508",
              "status": [
                {
                  "component": {
                    "@name": "\/a11a244b-ad4d-48fc-a952-08f85d7777d2-fs",
                    "@subType": "default",
                    "@implementation": "com.accenture.aspire.application.ComponentManagerImpl",
                    "@factoryName": "aspire-application",
                    "@description": "The default component manager implementation that is the Aspire Application itself.",
                    "config": {
                      "components": {
                        "component": [
                          {
                            "@name": "CrawlServicesProvider",
                            "@subType": "crawlServices",
                            "@factoryName": "aspire-connector-framework",
                            "debug": "false",
                            "infoCacheSize": "100",
                            "repositoryAccessPath": "RAP",
                            "scanListenerComponentPath": "\/a11a244b-ad4d-48fc-a952-08f85d7777d2-fs\/ScanPipelineManager\/Scan",
                            "workerComponentPath": "\/CFWorker\/WorkerNode"
                          },
                          {
                            "@name": "RAP",
                            "@subType": "default",
                            "@factoryName": "com.accenture.aspire:aspire-filesystem-source:5.2-SNAPSHOT",
                            "debug": "false"
                          },
                          {
                            "@name": "FetchUrl",
                            "@subType": "fetcher",
                            "@factoryName": "aspire-connector-framework",
                            "@enable": "true",
                            "enableFetcher": [
                              "true",
                              "true"
                            ],
                            "enableFetchForNonText": [
                              "true",
                              "true"
                            ],
                            "shared.data.dir": "C:\\app\\aspire5Worker2\\data\\shared",
                            "sampleProperty2": "false",
                            "sampleProperty1": "http:\/\/localhost:8983",
                            "sampleProperty4": "data",
                            "sampleProperty3": "data\/crawler",
                            "useCredentials": "false",
                            "processThreads": "20",
                            "workflowCleanUpThreshold": "1h",
                            "identityCacheSize": "100",
                            "extractTextMaxSize": "20971520",
                            "maxIdentitiesTimestamp": "3",
                            "extractTextConfiguration": "false",
                            "cs.config.dir": "C:\\app\\aspire5Worker2\\config\\content-sources\\a11a244b-ad4d-48fc-a952-08f85d7777d2-fs",
                            "maxCrawls": "3",
                            "publishFailedDocuments": "true",
                            "bundle.maven.coordinates": "com.accenture.aspire:aspire-filesystem-source:5.2-SNAPSHOT",
                            "setCacheSize": "100",
                            "enable-non-text-filter": "false",
                            "deleteCompleteQueueEntries": "false",
                            "aspire.home": "C:\\app\\aspire5Worker2",
                            "aspire.server.port": "50508",
                            "scanThreads": "10",
                            "nonTextDocumentsExtensions": "jpg,jpeg,gif,png,tif,mp3,mp4,mpg,mpeg,avi,mkv,wav,bmp,swf,war,rar,tgz,dll,exe,class",
                            "app.data.dir": "C:\\app\\aspire5Worker2\\data\\a11a244b-ad4d-48fc-a952-08f85d7777d2-fs",
                            "enableJobsStatistics": "true",
                            "connector.framework.feature.identityCrawling": "false",
                            "enableTextExtract": "true",
                            "hierarchyCacheSize": "5000",
                            "flushSyncTime": "15s",
                            "aspire.server.ip": "192.168.0.18",
                            "retriesEnabled": "true",
                            "component.home": "C:\\app\\aspire5Worker2\/cache\/appbundles\/com.accenture.aspire\/aspire-filesystem-source\/5.2-SNAPSHOT",
                            "processQueueTimeout": "300000",
                            "workflowCleanUpWaitTime": "1m",
                            "appbundle.home": "C:\\app\\aspire5Worker2\/cache\/appbundles\/com.accenture.aspire\/app-rap-connector\/5.2-SNAPSHOT",
                            "addHierarchy": "true",
                            "maxInCrawlRetries": "3",
                            "connector.framework.isRAP": "true",
                            "extractTimeout": "180000",
                            "scanQueueTimeout": "300000",
                            "app.name": "a11a244b-ad4d-48fc-a952-08f85d7777d2-fs",
                            "aspire.server.name": "C11-F2GIER94G97",
                            "connector.framework.feature.hierarchy": "true",
                            "wDebug": "false",
                            "debug": "false",
                            "structuredText": "false",
                            "app.config.dir": "C:\\app\\aspire5Worker2\\config\\content-sources\\a11a244b-ad4d-48fc-a952-08f85d7777d2-fs",
                            "enableStatistics": "true",
                            "removeFailedFromSnapshot": "false",
                            "infoCacheSize": "100",
                            "processQueue": "200",
                            "component.appbundle.maven.coordinates": "app-rap-connector",
                            "non-text-document": "true",
                            "aspire.config.dir": "C:\\app\\aspire5Worker2\\config",
                            "aspire.log.dir": "C:\\app\\aspire5Worker2\\log",
                            "useRetryPatterns": "false",
                            "connector.framework.feature.contentCrawling": "true",
                            "checkSnapshotAfterProcess": "false",
                            "mvnCoordinates": "com.accenture.aspire:aspire-filesystem-source",
                            "xmlMaxDepth": "100",
                            "connectorMaxBatchSize": "0",
                            "mapCacheSize": "100",
                            "tikaConfig": "",
                            "scanQueue": "50",
                            "workflowErrorTolerant": "false",
                            "dist.data.dir": "C:\\app\\aspire5Worker2\\data",
                            "svc.config.dir": "C:\\app\\aspire5Worker2\\config\\services\\a11a244b-ad4d-48fc-a952-08f85d7777d2-fs",
                            "$": ""
                          },
                          {
                            "@name": "DetectNonTextDocuments",
                            "@subType": "detectNonTextDocuments",
                            "@factoryName": "aspire-connector-framework",
                            "@enable": "true",
                            "enable-non-text-filter": "false",
                            "non-text-document": "true",
                            "nonTextDocumentsExtensions": "jpg,jpeg,gif,png,tif,mp3,mp4,mpg,mpeg,avi,mkv,wav,bmp,swf,war,rar,tgz,dll,exe,class",
                            "nonTextDocuments": "${nonTextDocuments}"
                          },
      ....

      Status: 200

       

       

       

      Download logs

      It downloads logs. It supports JSON filter on time range and it is downloaded as a file from the index aspire-log preserving JSON format used there. If the filter remains empty the whole log is downloaded. This endpoint needs the OPERATORS  role to be executed.

      POST /aspire/_api/debug/downloadLogs

      Filter Body Parameters Example

      {
          "filter": {
              "timestampFrom": 1691929080000,
              "timestampTo": 1691411697141,
              "component": "a11a244b-ad4d-48fc-a952-08f85d7777d2-fs",
              "severity": "WARN",
              "serverId": "192.168.0.18:50506"
          }
      }

      Status: 200

      Copyright © 2024 Accenture

      Contact Us: SCAAssetsSupport@accenture.com

      {"serverDuration": 29, "requestCorrelationId": "379dbe3a77304a75ad3d1531c31d768a"}