motiejus
/
jgit
1
Fork 0
Code Releases Activity
8,015 Commits 2 Branches 0 Tags 45 MiB
Java 98.8%
HTML 0.6%
Starlark 0.5%
Shell 0.1%
Go to file
Alexa Panfil a09e205176 Add new performance logging 
Add new performance logging to register events of type duration.
The proposed logging is similar to the performance logging
in OS Gerrit https://gerrit-review.googlesource.com/c/gerrit/+/225628:
a global Singleton (LoggingContext in Gerrit) is
collecting the performance logs in a thread-safe events list,
and at the end of the monitored command the list of events is
retrieved and written to a log, after which it is cleared.

What this patch does:
The main component is the Singleton (PerformanceLogContext), which
is used to collect the records (PerformanceLogRecord) in one place
(ThreadLocal eventsList) from anywhere using
PerformanceLogContext.getInstance().addEvent().

Reason why this change is needed:
The current monitoring in JGit has several issues:
1. git fetch and git push events are handled separately
(PackStatistics and ReceivedPackStatistics), with no unified way
of writing or reading the statistics.
2. PostUploadHook is only invoked on the event of sending the
pack, which means that the PackStatistics is not available for
the fetch requests that did not end with sending the pack
(negotiation requests).
3. The way the logs are created is different from the performance
log approach, so the long-running operations need to be collected
from both performance log (for JGit DFS overridden operations and
Gerrit operations) and gitlog (for JGit ones).

The proposed performance logging is going to solve the above
mentioned issues: it collects all of the performance logs in one
place, thus accounting for the commands that do not result in
sending a pack. The logs are compatible with the ones on Gerrit.
Moreover, the Singleton is accessible anywhere in the call stack,
which proved to be successful in other projects like Dapper
(https://research.google/pubs/pub36356/).

Signed-off-by: Alexa Panfil <alexapizza@google.com>
Change-Id: Iabfe667a3412d8a9db94aabb0f39b57f43469c41
 		2020-10-21 12:54:30 +00:00
.mvn Configure max heap size for Maven build 2016-12-09 11:02:10 +01:00
.settings Add resource preferences for top level jgit project 2019-12-16 11:20:12 +01:00
Documentation Document gc and pack relevant options 2020-04-03 11:50:27 +09:00
lib Decouple JSch from JGit Core 2020-06-01 01:46:59 +02:00
org.eclipse.jgit Add new performance logging 2020-10-21 12:54:30 +00:00
org.eclipse.jgit.ant Prepare 5.9.1-SNAPSHOT builds 2020-09-08 17:45:20 +02:00
org.eclipse.jgit.ant.test Prepare 5.10.0-SNAPSHOT builds 2020-08-27 16:14:36 +02:00
org.eclipse.jgit.archive Prepare 5.9.1-SNAPSHOT builds 2020-09-08 17:45:20 +02:00
org.eclipse.jgit.benchmarks Upgrade maven-project-info-reports-plugin to 3.1.1 2020-09-08 14:56:37 -04:00
org.eclipse.jgit.coverage Prepare 5.9.1-SNAPSHOT builds 2020-09-08 17:45:20 +02:00
org.eclipse.jgit.gpg.bc Merge branch 'stable-5.9' into master 2020-09-09 00:14:08 +02:00
org.eclipse.jgit.gpg.bc.test Prepare 5.9.1-SNAPSHOT builds 2020-09-08 17:45:20 +02:00
org.eclipse.jgit.http.apache Prepare 5.9.1-SNAPSHOT builds 2020-09-08 17:45:20 +02:00
org.eclipse.jgit.http.server Prepare 5.9.1-SNAPSHOT builds 2020-09-08 17:45:20 +02:00
org.eclipse.jgit.http.test Prepare 5.9.1-SNAPSHOT builds 2020-09-08 17:45:20 +02:00
org.eclipse.jgit.junit Prepare 5.9.1-SNAPSHOT builds 2020-09-08 17:45:20 +02:00
org.eclipse.jgit.junit.http Prepare 5.10.0-SNAPSHOT builds 2020-08-27 16:14:36 +02:00
org.eclipse.jgit.junit.ssh sshd: support the ProxyJump ssh config 2020-09-19 15:17:00 -04:00
org.eclipse.jgit.lfs Prepare 5.9.1-SNAPSHOT builds 2020-09-08 17:45:20 +02:00
org.eclipse.jgit.lfs.server Prepare 5.9.1-SNAPSHOT builds 2020-09-08 17:45:20 +02:00
org.eclipse.jgit.lfs.server.test Prepare 5.9.1-SNAPSHOT builds 2020-09-08 17:45:20 +02:00
org.eclipse.jgit.lfs.test Prepare 5.9.1-SNAPSHOT builds 2020-09-08 17:45:20 +02:00
org.eclipse.jgit.packaging Prepare 5.9.1-SNAPSHOT builds 2020-09-08 17:45:20 +02:00
org.eclipse.jgit.pgm Prepare 5.9.1-SNAPSHOT builds 2020-09-08 17:45:20 +02:00
org.eclipse.jgit.pgm.test Prepare 5.9.1-SNAPSHOT builds 2020-09-08 17:45:20 +02:00
org.eclipse.jgit.ssh.apache Support "http.userAgent" and "http.extraHeader" from the git config 2020-09-26 23:42:38 +02:00
org.eclipse.jgit.ssh.apache.test sshd: support the ProxyJump ssh config 2020-09-19 15:17:00 -04:00
org.eclipse.jgit.ssh.jsch Merge branch 'stable-5.9' into master 2020-09-09 00:14:08 +02:00
org.eclipse.jgit.ssh.jsch.test Prepare 5.10.0-SNAPSHOT builds 2020-08-27 16:14:36 +02:00
org.eclipse.jgit.test Add new performance logging 2020-10-21 12:54:30 +00:00
org.eclipse.jgit.ui Prepare 5.9.1-SNAPSHOT builds 2020-09-08 17:45:20 +02:00
tools Bazel: Add workspace status command to stamp final artifact 2020-07-17 01:10:15 +02:00
.bazelrc Bazel: Add workspace status command to stamp final artifact 2020-07-17 01:10:15 +02:00
.bazelversion Bump Bazel version to 3.5.0 2020-09-03 13:54:24 -04:00
.gitattributes Initial JGit contribution to eclipse.org 2009-09-29 16:47:03 -07:00
.gitignore .gitignore: remove editor- and OS-specific files 2019-04-01 13:38:00 -07:00
.mailmap Update .mailmap 2018-09-25 19:03:22 -04:00
BUILD [Java 11] Remove dependency on javax.xml.bind package 2019-06-18 02:22:21 +02:00
CONTRIBUTING.md Update SUBMITTING_PATCHES 2014-07-20 17:44:53 -04:00
LICENSE Clean up LICENSE file 2010-07-02 14:52:49 -07:00
README.md Update README 2019-02-19 08:34:38 +09:00
WORKSPACE Update target platform to R20200831200620 2020-09-01 01:08:26 +02:00
pom.xml Upgrade spotbugs-maven-plugin to 4.1.3 2020-10-06 08:37:34 -04:00

README.md

Java Git

An implementation of the Git version control system in pure Java.

This project is licensed under the EDL (Eclipse Distribution License).

JGit can be imported straight into Eclipse and built and tested from there. It can be built from the command line using Maven or Bazel. The CI builds use Maven and run on Jenkins.

  • org.eclipse.jgit

    A pure Java library capable of being run standalone, with no additional support libraries. It provides classes to read and write a Git repository and operate on a working directory.

    All portions of JGit are covered by the EDL. Absolutely no GPL, LGPL or EPL contributions are accepted within this package.

  • org.eclipse.jgit.ant

    Ant tasks based on JGit.

  • org.eclipse.jgit.archive

    Support for exporting to various archive formats (zip etc).

  • org.eclipse.jgit.http.apache

    Apache httpclient support.

  • org.eclipse.jgit.http.server

    Server for the smart and dumb Git HTTP protocol.

  • org.eclipse.jgit.lfs

    Support for LFS (Large File Storage).

  • org.eclipse.jgit.lfs.server

    Basic LFS server support.

  • org.eclipse.jgit.packaging

    Production of Eclipse features and p2 repository for JGit. See the JGit Wiki on why and how to use this module.

  • org.eclipse.jgit.pgm

    Command-line interface Git commands implemented using JGit ("pgm" stands for program).

  • org.eclipse.jgit.ssh.apache

    Client support for the ssh protocol based on Apache Mina sshd.

  • org.eclipse.jgit.ui

    Simple UI for displaying git log.

Tests

  • org.eclipse.jgit.junit, org.eclipse.jgit.junit.http, org.eclipse.jgit.junit.ssh: Helpers for unit testing
  • org.eclipse.jgit.ant.test: Unit tests for org.eclipse.jgit.ant
  • org.eclipse.jgit.http.test: Unit tests for org.eclipse.jgit.http.server
  • org.eclipse.jgit.lfs.server.test: Unit tests for org.eclipse.jgit.lfs.server
  • org.eclipse.jgit.lfs.test: Unit tests for org.eclipse.jgit.lfs
  • org.eclipse.jgit.pgm.test: Unit tests for org.eclipse.jgit.pgm
  • org.eclipse.jgit.ssh.apache.test: Unit tests for org.eclipse.jgit.ssh.apache
  • org.eclipse.jgit.test: Unit tests for org.eclipse.jgit

Warnings/Caveats

  • Native symbolic links are supported, provided the file system supports them. For Windows you must use a non-administrator account and have the SeCreateSymbolicLinkPrivilege.

  • Only the timestamp of the index is used by JGit if the index is dirty.

  • JGit requires at least a Java 8 JDK.

  • CRLF conversion is performed depending on the core.autocrlf setting, however Git for Windows by default stores that setting during installation in the "system wide" configuration file. If Git is not installed, use the global or repository configuration for the core.autocrlf setting.

  • The system wide configuration file is located relative to where C Git is installed. Make sure Git can be found via the PATH environment variable. When installing Git for Windows check the "Run Git from the Windows Command Prompt" option. There are other options like Eclipse settings that can be used for pointing out where C Git is installed. Modifying PATH is the recommended option if C Git is installed.

  • We try to use the same notation of $HOME as C Git does. On Windows this is often not the same value as the user.home system property.

Features

  • org.eclipse.jgit

    • Read loose and packed commits, trees, blobs, including deltafied objects.

    • Read objects from shared repositories

    • Write loose commits, trees, blobs.

    • Write blobs from local files or Java InputStreams.

    • Read blobs as Java InputStreams.

    • Copy trees to local directory, or local directory to a tree.

    • Lazily loads objects as necessary.

    • Read and write .git/config files.

    • Create a new repository.

    • Read and write refs, including walking through symrefs.

    • Read, update and write the Git index.

    • Checkout in dirty working directory if trivial.

    • Walk the history from a given set of commits looking for commits introducing changes in files under a specified path.

    • Object transport

      Fetch via ssh, git, http, Amazon S3 and bundles. Push via ssh, git and Amazon S3. JGit does not yet deltify the pushed packs so they may be a lot larger than C Git packs.

    • Garbage collection

    • Merge

    • Rebase

    • And much more

  • org.eclipse.jgit.pgm

    • Assorted set of command line utilities. Mostly for ad-hoc testing of jgit log, glog, fetch etc.

  • org.eclipse.jgit.ant

    • Ant tasks

  • org.eclipse.jgit.archive

    • Support for Zip/Tar and other formats

  • org.eclipse.http

    • HTTP client and server support

Missing Features

There are some missing features:

  • verifying signed commits
  • signing tags
  • signing push

Support

Post questions, comments or discussions to the jgit-dev@eclipse.org mailing list. You need to be subscribed to post. File bugs and enhancement requests in Bugzilla.

Contributing

See the EGit Contributor Guide.

About Git

More information about Git, its repository format, and the canonical C based implementation can be obtained from the Git website.