Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: improve docs around bundlers/transpilers, methods of starting the agent #2837

Merged
merged 26 commits into from Jul 29, 2022
Merged

docs: improve docs around bundlers/transpilers, methods of starting the agent #2837

merged 26 commits into from Jul 29, 2022

Commits on Jul 8, 2022

  1. ensure 'npm run test:babel' fails if not using 'elastic-apm-node/start' 

    Our docs on ESM usage with Babel state that you need to use
'elastic-apm-node/start' to instrument properly. Our test case should do
so too.
    @trentm
    trentm committed Jul 8, 2022
    Configuration menu
    Copy the full SHA
    ab89fce View commit details
    Browse the repository at this point in the history

  2. Merge branch 'main' into trentm/docs-bundlers-ts-etc

    @trentm
    trentm committed Jul 8, 2022
    Configuration menu
    Copy the full SHA
    d441fae View commit details
    Browse the repository at this point in the history

  3. update supported tech doc page: latest node release schedule image; a… 

    …dd ES Module support limitation note (will have to clarify the somewhat confusing es-modules.html content)
    @trentm
    trentm committed Jul 8, 2022
    Configuration menu
    Copy the full SHA
    e7a3ee7 View commit details
    Browse the repository at this point in the history

  4. Add "exports" so pure ESM can import 'elastic-apm-node/start' without. 

    This is experimental. I'm not sure if there are side-effects.
See #1967 (comment)
    @trentm
    trentm committed Jul 8, 2022
    Configuration menu
    Copy the full SHA
    9f741a5 View commit details
    Browse the repository at this point in the history

  5. a start at improved 'Starting the agent' docs; I still have to write … 

    …the Bundlers gotchas section
    @trentm
    trentm committed Jul 8, 2022
    Configuration menu
    Copy the full SHA
    2b0f892 View commit details
    Browse the repository at this point in the history

Commits on Jul 20, 2022

  1. a section on Bundlers gotchas, incl 'externals' config info for webpa… 

    …ck usage
    @trentm
    trentm committed Jul 20, 2022
    Configuration menu
    Copy the full SHA
    412e404 View commit details
    Browse the repository at this point in the history

  2. esbuild externals usage docs and example

    @trentm
    trentm committed Jul 20, 2022
    Configuration menu
    Copy the full SHA
    9023c1e View commit details
    Browse the repository at this point in the history

  3. more tweaks

    @trentm
    trentm committed Jul 20, 2022
    Configuration menu
    Copy the full SHA
    b1ac9a1 View commit details
    Browse the repository at this point in the history

Commits on Jul 21, 2022

  1. tweaks, not sure about 'exports' addition for this PR

    @trentm
    trentm committed Jul 21, 2022
    Configuration menu
    Copy the full SHA
    bb4587a View commit details
    Browse the repository at this point in the history

  2. drop the "exports", it can be problematic 

    Adding this with*out* extension would be problematic. Currently without
an "exports" a "foo.mjs" can `import 'elastic-apm-node/start.js'` (requires the .js)
and can `import 'elastic-apm-node/lib/config.js'` et al. That's fine. No
need to lock it down. If we *really* want the extension*less* access names,
then we need to add "exports"... which locks it down, which *could* be
breaking. So... let's not.
I think we should bias to including the extension as ESM becomes more popular.
    @trentm
    trentm committed Jul 21, 2022
    Configuration menu
    Copy the full SHA
    ad0cf5c View commit details
    Browse the repository at this point in the history

  3. fix 'make check'

    @trentm
    trentm committed Jul 21, 2022
    Configuration menu
    Copy the full SHA
    87b2157 View commit details
    Browse the repository at this point in the history

Commits on Jul 26, 2022

  1. replace es-modules.html page with a new 'Get started with TypeScript'… 

    … and reference to the updated sdtarting-the-agent docs and the ES Modules section in supported-technologies. Also add the start-option-separate-init-module start option.
    @trentm
    trentm committed Jul 26, 2022
    Configuration menu
    Copy the full SHA
    de96baf View commit details
    Browse the repository at this point in the history

  2. update ESM section

    @trentm
    trentm committed Jul 26, 2022
    Configuration menu
    Copy the full SHA
    ebbdbd4 View commit details
    Browse the repository at this point in the history

  3. tweak

    @trentm
    trentm committed Jul 26, 2022
    Configuration menu
    Copy the full SHA
    e49f497 View commit details
    Browse the repository at this point in the history

  4. tweaks and asciidoc syntax fixes

    @trentm
    trentm committed Jul 26, 2022
    Configuration menu
    Copy the full SHA
    855df00 View commit details
    Browse the repository at this point in the history

Commits on Jul 28, 2022

  1. grammar 

    Co-authored-by: Brandon Morelli <brandon.morelli@elastic.co>
    @trentm @bmorelli25
    trentm and bmorelli25 committed Jul 28, 2022
    Configuration menu
    Copy the full SHA
    78d8fde View commit details
    Browse the repository at this point in the history

  2. consistently code-format node 

    Co-authored-by: Brandon Morelli <brandon.morelli@elastic.co>
    @trentm @bmorelli25
    trentm and bmorelli25 committed Jul 28, 2022
    Configuration menu
    Copy the full SHA
    1a371c7 View commit details
    Browse the repository at this point in the history

  3. capitalization 

    Co-authored-by: Brandon Morelli <brandon.morelli@elastic.co>
    @trentm @bmorelli25
    trentm and bmorelli25 committed Jul 28, 2022
    Configuration menu
    Copy the full SHA
    d67d660 View commit details
    Browse the repository at this point in the history

  4. capitalization 

    Co-authored-by: Brandon Morelli <brandon.morelli@elastic.co>
    @trentm @bmorelli25
    trentm and bmorelli25 committed Jul 28, 2022
    Configuration menu
    Copy the full SHA
    60bb3a7 View commit details
    Browse the repository at this point in the history

  5. emdash FTW 

    Co-authored-by: Brandon Morelli <brandon.morelli@elastic.co>
    @trentm @bmorelli25
    trentm and bmorelli25 committed Jul 28, 2022
    Configuration menu
    Copy the full SHA
    4f12d50 View commit details
    Browse the repository at this point in the history

  6. caps 

    Co-authored-by: Brandon Morelli <brandon.morelli@elastic.co>
    @trentm @bmorelli25
    trentm and bmorelli25 committed Jul 28, 2022
    Configuration menu
    Copy the full SHA
    5a7360e View commit details
    Browse the repository at this point in the history

  7. phrasing 

    Co-authored-by: Brandon Morelli <brandon.morelli@elastic.co>
    @trentm @bmorelli25
    trentm and bmorelli25 committed Jul 28, 2022
    Configuration menu
    Copy the full SHA
    515709d View commit details
    Browse the repository at this point in the history

Commits on Jul 29, 2022

  1. improvements mostly as Brandon suggested

    @trentm
    trentm committed Jul 29, 2022
    Configuration menu
    Copy the full SHA
    c9fb5c3 View commit details
    Browse the repository at this point in the history

  2. I put my thang down, flip it and reverse it

    @trentm
    trentm committed Jul 29, 2022
    Configuration menu
    Copy the full SHA
    e76ab76 View commit details
    Browse the repository at this point in the history

  3. .start() consistency

    @trentm
    trentm committed Jul 29, 2022
    Configuration menu
    Copy the full SHA
    d410b09 View commit details
    Browse the repository at this point in the history

  4. s/function/method/ for consistency

    @trentm
    trentm committed Jul 29, 2022
    Configuration menu
    Copy the full SHA
    0e305c1 View commit details
    Browse the repository at this point in the history