Versions Compared

Old Version 2

changes.mady.by.user Petr Podsednik

Saved on

compared with

New Version 3

changes.mady.by.user Petr Podsednik

Saved on

Key

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


The metrics API provides various performance metrics

Easy Heading Free
navigationTitleOn this Page
navigationExpandOptionexpand-all-by-default

Section

Crawl metrics

Creates crawl metrics report

Fetch one or more batches

Used by the worker to fetch a batch from the manager. This endpoint needs at least the ADMINISTRATOR or WORKER ADMINISTRATOR  role to be executed.

Panel
borderColorblack
bgColor#fafafb

GET /aspire/_api/metrics/manager:seedId/batch:crawlId

Path and Request Body Parameters

NameTypeRequiredDescription
workerseedIdstringRequiredThe id of the worker asking for the batch
typecrawlIdstringRequired

The type of batch required

  • scan
  • process
tagsstringOptionalThe tags this machine has
itemsnumberOptionalThe number of items to fetch

Response

Code Block
languagejs
themeRDark
{
  "batch": {
    "id": 0,
    "type": "process",
    "connector": "myConnectorId",
    "entry": [{
      "_id": "item_id_1",
      "url": "item_url_1",
      "type": "com.accenture.aspire.connector.manager.ManagerComponent$FSItemType@filesystem",
      "status": "A",
      "action": "add",
      "timestamp": 1234567890,
      "shouldScan": true,
      "shouldProcess": true,
      "crawlRetries": 0,
      "isCrawlRootItem": false,
      "inCrawlRetries": 0
    }, {
      "_id": "item_id_2",
      "url": "item_url_2",
      "type": "com.accenture.aspire.connector.manager.ManagerComponent$FSItemType@folder",
      "status": "A",
      "action": "update",
      "timestamp": 1234567890,
      "shouldScan": true,
      "shouldProcess": true,
      "crawlRetries": 0,
      "isCrawlRootItem": false,
      "inCrawlRetries": 0
    }]
  },
  "message": "optional response message"
}

Status: 200, 406



Section

Acknowledge one or more batches

Used by the worker node to acknowledge the worker has taken responsibility for the batch(es). This endpoint needs at least the ADMINISTRATOR or WORKER role to be executed.

Panel
borderColorblack
bgColor#fafafb

PUT /aspire/_api/manager/batch/ack/:id

PUT /aspire/_api/manager/batch/ack


Query String Parameters

NameTypeRequiredDescription
typestringRequired

The type of the batch

  • scan
  • process


Path and Request Body Parameters

NameTypeRequiredDescription
idstringRequiredThe identifier(s) of the batch(es) to be acknowledged

Examples

Acknowledge a single batch

Code Block
languagejs
themeRDark
PUT /aspire/_api/manager/batch/ack/AAABcID5GBc=?type=scan

PUT /aspire/_api/manager/batch/ack?type=scan
{
  "id": ["AAABcID5GBc="]
}

Acknowledge multiple batches

Code Block
languagejs
themeRDark
PUT /aspire/_api/manager/batch/ack?type=scan
{
  "id": ["AAABcID5GBc=", "AAABcIueWUc="]
}

Response

Code Block
languagejs
themeRDark
{
  "message": "optional response message"
}

Status: 200, 404