@crawlee/puppeteer
Provides a simple framework for parallel crawling of web pages using headless Chrome with Puppeteer. The URLs to crawl are fed either from a static list of URLs or from a dynamic queue of URLs enabling recursive crawling of websites.
Since PuppeteerCrawler
uses headless Chrome to download web pages and extract data, it is useful for crawling of websites that require to execute JavaScript. If the target website doesn't need JavaScript, consider using CheerioCrawler, which downloads the pages using raw HTTP requests and is about 10x faster.
The source URLs are represented using Request objects that are fed from RequestList or RequestQueue instances provided by the PuppeteerCrawlerOptions.requestList or PuppeteerCrawlerOptions.requestQueue constructor options, respectively.
If both PuppeteerCrawlerOptions.requestList and PuppeteerCrawlerOptions.requestQueue are used, the instance first processes URLs from the RequestList and automatically enqueues all of them to RequestQueue before it starts their processing. This ensures that a single URL is not crawled multiple times.
The crawler finishes when there are no more Request objects to crawl.
PuppeteerCrawler
opens a new Chrome page (i.e. tab) for each Request object to crawl
and then calls the function provided by user as the PuppeteerCrawlerOptions.requestHandler option.
New pages are only opened when there is enough free CPU and memory available,
using the functionality provided by the AutoscaledPool class.
All AutoscaledPool configuration options can be passed to the PuppeteerCrawlerOptions.autoscaledPoolOptions
parameter of the PuppeteerCrawler
constructor. For user convenience, the minConcurrency
and maxConcurrency
AutoscaledPoolOptions are available directly in the PuppeteerCrawler
constructor.
Note that the pool of Puppeteer instances is internally managed by the BrowserPool class.
Example usage
const crawler = new PuppeteerCrawler({
async requestHandler({ page, request }) {
// This function is called to extract data from a single web page
// 'page' is an instance of Puppeteer.Page with page.goto(request.url) already called
// 'request' is an instance of Request class with information about the page to load
await Dataset.pushData({
title: await page.title(),
url: request.url,
succeeded: true,
})
},
async failedRequestHandler({ request }) {
// This function is called when the crawling of a request failed too many times
await Dataset.pushData({
url: request.url,
succeeded: false,
errors: request.errorMessages,
})
},
});
await crawler.run([
'http://www.example.com/page-1',
'http://www.example.com/page-2',
]);
Index
Crawlers
Other
- AddRequestsBatchedOptions
- AddRequestsBatchedResult
- AutoscaledPool
- AutoscaledPoolOptions
- BASIC_CRAWLER_TIMEOUT_BUFFER_SECS
- BLOCKED_STATUS_CODES
- BasicCrawler
- BasicCrawlerOptions
- BasicCrawlingContext
- BlockRequestsOptions
- BrowserCrawler
- BrowserCrawlerOptions
- BrowserCrawlingContext
- BrowserErrorHandler
- BrowserHook
- BrowserLaunchContext
- BrowserRequestHandler
- ClientInfo
- CompiledScriptFunction
- CompiledScriptParams
- Configuration
- ConfigurationOptions
- Cookie
- CrawlerAddRequestsOptions
- CrawlerAddRequestsResult
- CrawlerExperiments
- CrawlerRunOptions
- CrawlingContext
- CreateContextOptions
- CreateSession
- CriticalError
- Dataset
- DatasetConsumer
- DatasetContent
- DatasetDataOptions
- DatasetExportOptions
- DatasetExportToOptions
- DatasetIteratorOptions
- DatasetMapper
- DatasetOptions
- DatasetReducer
- EnqueueLinksByClickingElementsOptions
- EnqueueLinksOptions
- EnqueueStrategy
- ErrnoException
- ErrorHandler
- ErrorSnapshotter
- ErrorTracker
- ErrorTrackerOptions
- EventManager
- EventType
- EventTypeName
- FinalStatistics
- GetUserDataFromRequest
- GlobInput
- GlobObject
- IRequestList
- IStorage
- InfiniteScrollOptions
- InjectFileOptions
- InterceptHandler
- KeyConsumer
- KeyValueStore
- KeyValueStoreIteratorOptions
- KeyValueStoreOptions
- LoadedRequest
- LocalEventManager
- Log
- LogLevel
- Logger
- LoggerJson
- LoggerOptions
- LoggerText
- MAX_POOL_SIZE
- NonRetryableError
- PERSIST_STATE_KEY
- PersistenceOptions
- ProxyConfiguration
- ProxyConfigurationFunction
- ProxyConfigurationOptions
- ProxyInfo
- PseudoUrl
- PseudoUrlInput
- PseudoUrlObject
- PuppeteerDirectNavigationOptions
- PushErrorMessageOptions
- QueueOperationInfo
- RecordOptions
- RegExpInput
- RegExpObject
- Request
- RequestHandler
- RequestHandlerResult
- RequestList
- RequestListOptions
- RequestListSourcesFunction
- RequestListState
- RequestOptions
- RequestProvider
- RequestProviderOptions
- RequestQueue
- RequestQueueOperationOptions
- RequestQueueOptions
- RequestQueueV1
- RequestQueueV2
- RequestState
- RequestTransform
- RestrictedCrawlingContext
- RetryRequestError
- Router
- RouterHandler
- RouterRoutes
- SaveSnapshotOptions
- Session
- SessionError
- SessionOptions
- SessionPool
- SessionPoolOptions
- SessionState
- SitemapRequestList
- SitemapRequestListOptions
- SnapshotResult
- Snapshotter
- SnapshotterOptions
- Source
- StatisticPersistedState
- StatisticState
- Statistics
- StatisticsOptions
- StatusMessageCallback
- StatusMessageCallbackParams
- StorageClient
- StorageManagerOptions
- SystemInfo
- SystemStatus
- SystemStatusOptions
- TieredProxy
- UrlPatternObject
- UseStateOptions
- checkStorageAccess
- createBasicRouter
- enqueueLinks
- filterRequestsByPatterns
- log
- purgeDefaultStorages
- tryAbsoluteURL
- useState
- withCheckedStorageAccess
- puppeteerClickElements
- puppeteerRequestInterception
- puppeteerUtils
- PuppeteerCrawlerOptions
- PuppeteerCrawlingContext
- PuppeteerHook
- PuppeteerLaunchContext
- PuppeteerRequestHandler
- PuppeteerGoToOptions
- createPuppeteerRouter
- launchPuppeteer