@portnoy/pulsar-sdk
v0.2.0
Published
Pulsar Analytics JavaScript SDK — autotrack page views, clicks, and form submits with zero code changes.
Maintainers
Readme
@portnoy/pulsar-sdk
Pulsar Analytics 의 JavaScript SDK. 페이지뷰·클릭·폼 제출을 코드 수정 없이 자동 수집(autotrack)하고, 필요하면 직접 이벤트를 전송한다.
설치
npm install @portnoy/pulsar-sdk또는 브라우저에서 직접:
<script type="module">
import { Pulsar } from 'https://cdn.jsdelivr.net/npm/@portnoy/pulsar-sdk/dist/index.js'
const pulsar = new Pulsar({ publicKey: 'YOUR_API_KEY', endpoint: 'https://your-ingest', autotrack: true })
</script>사용
import { Pulsar } from '@portnoy/pulsar-sdk'
const pulsar = new Pulsar({
publicKey: 'YOUR_API_KEY',
endpoint: 'https://your-ingest-host',
autotrack: true, // page_view · click · form_submit 자동 수집
})
pulsar.identify('user_123') // 로그인 시 유저 식별
pulsar.track('purchase', { amount: 30000, currency: 'KRW' }) // 직접 이벤트오토트랙
autotrack: true 면 다음을 자동 수집한다.
- page_view — 최초 로드 + SPA 라우팅(history) 변경 시.
path,url,title,referrer포함. - click —
button/a/[role=button]/[data-ep-track]클릭 시.selector,text,tag등 포함. - form_submit —
form제출 시.form_id,form_name,action포함.
특정 요소만 추적하려면 data-ep-track="이름" 속성을 단다.
세부 선택:
new Pulsar({ publicKey, autotrack: { pageViews: true, clicks: true, forms: false } })설정
| 옵션 | 기본값 | 설명 |
|------|--------|------|
| publicKey | (필수) | 프로젝트 Public API Key |
| endpoint | http://localhost:8000 | Ingest 서버 주소 |
| batchSize | 20 | 배치 전송 크기 |
| flushInterval | 5000 | 자동 flush 주기(ms) |
| autotrack | false | true 또는 { pageViews, clicks, forms } |
API
track(eventType, properties?)— 이벤트 전송identify(userId)— 유저 식별reset()— 유저 식별 해제(로그아웃)flush()— 큐 강제 전송dispose()— 오토트랙 리스너 해제 + 큐 비우기
