amplitude/Amplitude-Node

Passing device Id upon initialization

Open

#36 opened on Sep 28, 2020

View on GitHubContributor guide
 (4 comments) (0 reactions) (0 assignees)TypeScript (20 forks)auto 404
enhancementgood first issue

Repository metrics

Stars
 (73 stars)
PR merge metrics
 (PR metrics pending)

Description

Summary

Hey,

We are currently using the node SDK for amplitude in one of our backends. It seems that in order to log an event to amplitude, the device id or user id is required as specified here: https://developers.amplitude.com/docs/http-api-v2#properties-1

Currently our backend does not track our users. We wanted to pass a variable for the device_id such as : service_server which would just be the name of our backend.

const amplitude = init(AMPLITUDE_TOKEN, { device_id: AMPLITUDE_DEVICE_ID });

Motivations

This would allow us to avoid passing the deviceId every time we want to log an event, which is not ideal since it is always the same anyways.

Don't hesitate to let me know if there is a better way of doing this. I'm new to using amplitude :)

Contributor guide

Research direction
Explore the init function in the Amplitude Node SDK source code to find where options like apiKey are processed. Add a device id option that sets the deviceId property on the client instance, ensuring it is used in event payloads unless overridden per event.
Tech stack
typescriptnodejs
Domain
backendapi
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitNode.jsTypeScript
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75