https://github.com/zachgoldstein/scrapy-statsd

Statsd integration middleware for scrapy
https://github.com/zachgoldstein/scrapy-statsd

Last synced: 25 days ago
JSON representation

Statsd integration middleware for scrapy

• Host: GitHub
• URL: https://github.com/zachgoldstein/scrapy-statsd
• Owner: zachgoldstein
• License: other
• Created: 2016-08-27T22:57:44.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2018-06-03T16:48:55.000Z (over 6 years ago)
• Last Synced: 2024-09-26T01:34:35.387Z (3 months ago)
• Language: Python
• Size: 11.7 KB
• Stars: 7
• Watchers: 2
• Forks: 5
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-scrapy - scrapy-statsd-middleware

README

        
# Scrapy Statsd Middleware

## Usage

```

pip install scrapy-statsd-middleware

```

```

DOWNLOADER_MIDDLEWARES = {

  'statsd_middleware.StatsdMiddleware': 543,

}

SPIDER_MIDDLEWARES = {

  'statsd_middleware.StatsdMiddleware': 543,

}

```

There's also a few settings that you can use:

-   `STATSD_HOSTNAME` - Defaults to the current machine's hostname

-   `STATSD_PREFIX` - Defaults to "hostname.spider-name."

-   `STATSD_HOST_IP` - Defaults to "0.0.0.0"

This will increment `statsd` with the following:

- requests (`spider_reqs_issued`)

- response (`spider_resps_received`)

- errors (`error_KeyError`, where KeyError is whatever the error name is)

- items processed (`processed_product`, where Product is whatever the item class name is)

## Example Implementation

An example implementation of this middleware is in /example.

It includes a docker-compose file that describes how to use this middleware with statsd & graphite

## Example Installation & Usage

-   Build the docker images: `docker-compose build`

-   Start the statsd container: `docker-compose up -d`

-   Run the example spider: `docker-compose -f ./example/docker-compose.yml run spider bash -c "cd ./opt/scrapy/dirbot/ && scrapy crawl dmoz"`

You can see a live graphite dashboard at  You should see stats show up under something like "stats.Z-MacBook-Pro.local.dmoz.spider_reqs_issued"

## Development

You can run the tests via make test